The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -96453,6 +96510,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96471,6 +96537,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -97033,6 +97108,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -97073,6 +97156,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -97089,6 +97180,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98641,6 +98740,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98686,6 +98794,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98704,6 +98821,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -99461,6 +99587,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -99501,6 +99635,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99517,6 +99659,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -101068,6 +101218,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -101108,6 +101266,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -101124,6 +101290,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102178,6 +102352,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102218,6 +102400,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102234,6 +102424,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -103286,6 +103484,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -103326,6 +103532,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -103342,6 +103556,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105665,6 +105887,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105705,6 +105935,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105721,6 +105959,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -111018,6 +111264,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -111058,6 +111312,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -111074,6 +111336,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -112061,6 +112331,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -112101,6 +112379,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -112117,6 +112403,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -423926,6 +424220,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -423966,6 +424268,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -423982,6 +424292,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -444682,6 +445000,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -445803,6 +446170,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -447196,6 +447605,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -448602,6 +449060,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -449728,6 +450235,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -451122,6 +451671,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -476627,6 +477225,76 @@ ], "allowsPublicRead": true } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/{user_id}/projectsV2/{project_number}/drafts", + "title": "Create draft item for user owned project", + "category": "projects", + "subcategory": "drafts", + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "The title of the draft issue item to create in the project.
", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "in": "body", + "description": "The body content of the draft issue item to create in the project.
" + } + ], + "descriptionHTML": "Create draft issue item for the specified user owned project.
", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } } ], "fields": [ @@ -476711,21 +477379,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -476740,21 +477426,39 @@ "options": [ { "id": "option_4", - "name": "Todo", + "name": { + "html": "Todo", + "raw": "Todo" + }, "color": "GRAY", - "description": "Items to be worked on" + "description": { + "html": "Items to be worked on", + "raw": "Items to be worked on" + } }, { "id": "option_5", - "name": "In Progress", + "name": { + "html": "In Progress", + "raw": "In Progress" + }, "color": "BLUE", - "description": "Items currently being worked on" + "description": { + "html": "Items currently being worked on", + "raw": "Items currently being worked on" + } }, { "id": "option_6", - "name": "Done", + "name": { + "html": "Done", + "raw": "Done" + }, "color": "GREEN", - "description": "Completed items" + "description": { + "html": "Completed items", + "raw": "Completed items" + } } ], "created_at": "2022-04-29T10:30:00Z", @@ -476799,13 +477503,19 @@ "iterations": [ { "id": "iter_1", - "title": "Sprint 1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", - "title": "Sprint 2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, "start_date": "2022-07-15", "duration": 14 } @@ -477434,21 +478144,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -477463,21 +478191,39 @@ "options": [ { "id": "option_4", - "name": "Todo", + "name": { + "html": "Todo", + "raw": "Todo" + }, "color": "GRAY", - "description": "Items to be worked on" + "description": { + "html": "Items to be worked on", + "raw": "Items to be worked on" + } }, { "id": "option_5", - "name": "In Progress", + "name": { + "html": "In Progress", + "raw": "In Progress" + }, "color": "BLUE", - "description": "Items currently being worked on" + "description": { + "html": "Items currently being worked on", + "raw": "Items currently being worked on" + } }, { "id": "option_6", - "name": "Done", + "name": { + "html": "Done", + "raw": "Done" + }, "color": "GREEN", - "description": "Completed items" + "description": { + "html": "Completed items", + "raw": "Completed items" + } } ], "created_at": "2022-04-29T10:30:00Z", @@ -477522,13 +478268,19 @@ "iterations": [ { "id": "iter_1", - "title": "Sprint 1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", - "title": "Sprint 2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, "start_date": "2022-07-15", "duration": 14 } @@ -478668,8 +479420,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -478712,11 +479464,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -495106,8 +495862,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -495150,11 +495906,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -496233,8 +496993,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -496277,11 +497037,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -497267,8 +498031,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -497311,11 +498075,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -498301,8 +499069,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -498345,11 +499113,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -499335,8 +500107,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -499379,11 +500151,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -500369,8 +501145,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -500413,11 +501189,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -501596,8 +502376,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -501640,11 +502420,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -518024,8 +518808,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -518068,11 +518852,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -519146,8 +519934,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -519190,11 +519978,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -520180,8 +520972,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -520224,11 +521016,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -521214,8 +522010,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -521258,11 +522054,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -522248,8 +523048,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -522292,11 +523092,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -523282,8 +524086,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -523326,11 +524130,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -624942,6 +625750,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -626743,6 +627600,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -627785,6 +628691,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -629195,6 +630143,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -630611,6 +631608,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -631658,6 +632704,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -633069,6 +634157,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index e74d8046a52e..b2038c591c3f 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -105152,6 +105152,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105192,6 +105200,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105208,6 +105224,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -106273,6 +106297,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -106313,6 +106345,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -106329,6 +106369,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -107077,6 +107125,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -107122,6 +107179,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -107140,6 +107206,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -107720,6 +107795,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -107760,6 +107843,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -107776,6 +107867,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -109344,6 +109443,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -109389,6 +109497,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -109407,6 +109524,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -110182,6 +110308,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -110222,6 +110356,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -110238,6 +110380,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -111805,6 +111955,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -111845,6 +112003,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -111861,6 +112027,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -112931,6 +113105,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -112971,6 +113153,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -112987,6 +113177,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -114055,6 +114253,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -114095,6 +114301,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -114111,6 +114325,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -116450,6 +116672,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -116490,6 +116720,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -116506,6 +116744,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -121819,6 +122065,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -121859,6 +122113,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -121875,6 +122137,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -122878,6 +123148,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -122918,6 +123196,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -122934,6 +123220,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -265683,438 +265977,6 @@ "permissions": [] } }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day", - "title": "Get Copilot enterprise usage metrics for a specific day", - "category": "copilot", - "subcategory": "copilot-metrics", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "day", - "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.
\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", - "example": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" - }, - "schema": { - "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." - }, - "report_day": { - "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_day" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Enterprise Copilot metrics\" enterprise permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest", - "title": "Get Copilot enterprise usage metrics", - "category": "copilot", - "subcategory": "copilot-metrics", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.
\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", - "example": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - }, - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Enterprise Copilot metrics\" enterprise permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day", - "title": "Get Copilot users usage metrics for a specific day", - "category": "copilot", - "subcategory": "copilot-metrics", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "day", - "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.
\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", - "example": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_day": "2025-07-01" - }, - "schema": { - "type": "object", - "title": "Copilot Metrics 1 Day Report", - "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." - }, - "report_day": { - "type": "string", - "format": "date", - "description": "The day of the report in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_day" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Enterprise Copilot metrics\" enterprise permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest", - "title": "Get Copilot users usage metrics", - "category": "copilot", - "subcategory": "copilot-metrics", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.
\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", - "example": { - "download_links": [ - "https://example.com/copilot-usage-report-1.json", - "https://example.com/copilot-usage-report-2.json" - ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" - }, - "schema": { - "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise.", - "properties": { - "download_links": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." - }, - "report_end_day": { - "type": "string", - "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." - } - }, - "required": [ - "download_links", - "report_start_day", - "report_end_day" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Enterprise Copilot metrics\" enterprise permissions": "read" - } - ] - } - }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -267875,6 +267737,440 @@ } } ], + "copilot-usage-metrics": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day", + "title": "Get Copilot enterprise usage metrics for a specific day", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.
\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest", + "title": "Get Copilot enterprise usage metrics", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.
\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.
\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day", + "title": "Get Copilot users usage metrics for a specific day", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in YYYY-MM-DD format.
Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.
\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest", + "title": "Get Copilot users usage metrics", + "category": "copilot", + "subcategory": "copilot-usage-metrics", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.
\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.
\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.
\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.
Response
", + "example": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + }, + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] + } + } + ], "copilot-user-management": [ { "serverUrl": "https://api.github.com", @@ -306883,6 +307179,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -306923,6 +307227,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -306939,6 +307251,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -307813,6 +308133,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -307853,6 +308181,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -307869,6 +308205,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -309226,6 +309570,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -309266,6 +309618,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -309282,6 +309642,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -311103,6 +311471,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -312462,6 +312872,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -313849,6 +314308,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -315378,6 +315886,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -316738,6 +317288,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -470172,6 +470771,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -470212,6 +470819,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -470228,6 +470843,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -495448,6 +496071,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -496570,6 +497242,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -497964,6 +498678,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -499371,6 +500134,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -500498,6 +501310,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -501893,6 +502747,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -527512,6 +528415,76 @@ ], "allowsPublicRead": true } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/{user_id}/projectsV2/{project_number}/drafts", + "title": "Create draft item for user owned project", + "category": "projects", + "subcategory": "drafts", + "parameters": [ + { + "name": "user_id", + "description": "The unique identifier of the user.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "The title of the draft issue item to create in the project.
", + "isRequired": true + }, + { + "type": "string", + "name": "body", + "in": "body", + "description": "The body content of the draft issue item to create in the project.
" + } + ], + "descriptionHTML": "Create draft issue item for the specified user owned project.
", + "codeExamples": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } } ], "fields": [ @@ -527596,21 +528569,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -527625,21 +528616,39 @@ "options": [ { "id": "option_4", - "name": "Todo", + "name": { + "html": "Todo", + "raw": "Todo" + }, "color": "GRAY", - "description": "Items to be worked on" + "description": { + "html": "Items to be worked on", + "raw": "Items to be worked on" + } }, { "id": "option_5", - "name": "In Progress", + "name": { + "html": "In Progress", + "raw": "In Progress" + }, "color": "BLUE", - "description": "Items currently being worked on" + "description": { + "html": "Items currently being worked on", + "raw": "Items currently being worked on" + } }, { "id": "option_6", - "name": "Done", + "name": { + "html": "Done", + "raw": "Done" + }, "color": "GREEN", - "description": "Completed items" + "description": { + "html": "Completed items", + "raw": "Completed items" + } } ], "created_at": "2022-04-29T10:30:00Z", @@ -527684,13 +528693,19 @@ "iterations": [ { "id": "iter_1", - "title": "Sprint 1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", - "title": "Sprint 2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, "start_date": "2022-07-15", "duration": 14 } @@ -528319,21 +529334,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -528348,21 +529381,39 @@ "options": [ { "id": "option_4", - "name": "Todo", + "name": { + "html": "Todo", + "raw": "Todo" + }, "color": "GRAY", - "description": "Items to be worked on" + "description": { + "html": "Items to be worked on", + "raw": "Items to be worked on" + } }, { "id": "option_5", - "name": "In Progress", + "name": { + "html": "In Progress", + "raw": "In Progress" + }, "color": "BLUE", - "description": "Items currently being worked on" + "description": { + "html": "Items currently being worked on", + "raw": "Items currently being worked on" + } }, { "id": "option_6", - "name": "Done", + "name": { + "html": "Done", + "raw": "Done" + }, "color": "GREEN", - "description": "Completed items" + "description": { + "html": "Completed items", + "raw": "Completed items" + } } ], "created_at": "2022-04-29T10:30:00Z", @@ -528407,13 +529458,19 @@ "iterations": [ { "id": "iter_1", - "title": "Sprint 1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", - "title": "Sprint 2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, "start_date": "2022-07-15", "duration": 14 } @@ -529553,8 +530610,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -529597,11 +530654,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -545991,8 +547052,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -546035,11 +547096,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -547118,8 +548183,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -547162,11 +548227,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -548152,8 +549221,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -548196,11 +549265,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -549186,8 +550259,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -549230,11 +550303,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -550220,8 +551297,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -550264,11 +551341,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -551254,8 +552335,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -551298,11 +552379,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -552481,8 +553566,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -552525,11 +553610,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -568909,8 +569998,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -568953,11 +570042,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -570031,8 +571124,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -570075,11 +571168,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -571065,8 +572162,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -571109,11 +572206,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -572099,8 +573200,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -572143,11 +573244,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -573133,8 +574238,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -573177,11 +574282,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -574167,8 +575276,8 @@ "name": "Title", "type": "title", "value": { - "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", "number": 6, "url": "https://github.com/5/1/pull/6", "issue_id": 12, @@ -574211,11 +575320,15 @@ "type": "single_select", "value": { "id": "98236657", - "name": "Done", - "name_html": "Done", + "name": { + "raw": "Done", + "html": "Done" + }, "color": "PURPLE", - "description": "This has been completed", - "description_html": "This has been completed" + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } } }, { @@ -678583,6 +679696,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -680385,6 +681547,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -681428,6 +682639,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -682839,6 +684092,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -684256,6 +685558,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -685304,6 +686655,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -686716,6 +688109,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 4d5abce48836..8a1583ffdb30 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -94093,6 +94093,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -94133,6 +94141,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -94149,6 +94165,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95181,6 +95205,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -95221,6 +95253,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -95237,6 +95277,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95952,6 +96000,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -95997,6 +96054,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96015,6 +96081,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -96558,6 +96633,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -96598,6 +96681,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -96614,6 +96705,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98149,6 +98248,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98194,6 +98302,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98212,6 +98329,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -98950,6 +99076,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -98990,6 +99124,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99006,6 +99148,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -100534,6 +100684,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -100574,6 +100732,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -100590,6 +100756,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -101627,6 +101801,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -101667,6 +101849,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -101683,6 +101873,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102718,6 +102916,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102758,6 +102964,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102774,6 +102988,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105080,6 +105302,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105120,6 +105350,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105136,6 +105374,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -107546,6 +107792,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -107586,6 +107840,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -107602,6 +107864,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -108572,6 +108842,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -108612,6 +108890,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -108628,6 +108914,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -221568,6 +221862,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -221608,6 +221910,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -221624,6 +221934,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -222992,6 +223310,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -223032,6 +223358,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -223048,6 +223382,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -223941,6 +224283,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -223981,6 +224331,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -223997,6 +224355,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -331968,6 +332334,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -332008,6 +332382,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -332024,6 +332406,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -332998,6 +333388,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -333038,6 +333436,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -333054,6 +333460,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -334043,6 +334457,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -334083,6 +334505,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -334099,6 +334529,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -334995,6 +335433,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -335035,6 +335481,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -335051,6 +335505,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -336044,6 +336506,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -336084,6 +336554,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -336100,6 +336578,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -336997,6 +337483,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -337037,6 +337531,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -337053,6 +337555,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -337984,6 +338494,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -338024,6 +338542,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -338040,6 +338566,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -339022,6 +339556,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -339062,6 +339604,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -339078,6 +339628,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -342338,6 +342896,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -342378,6 +342944,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -342394,6 +342968,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -358075,6 +358657,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -359038,6 +359669,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -360220,6 +360893,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -361382,6 +362104,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -362350,6 +363121,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -363523,6 +364336,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -487450,6 +488312,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -488877,6 +489788,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -489685,6 +490645,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -490838,6 +491840,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -492010,6 +493061,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -492823,6 +493923,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -493977,6 +495119,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 6ab3477b980e..0c1ee83f7f5f 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -94417,6 +94417,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -94457,6 +94465,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -94473,6 +94489,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95513,6 +95537,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -95553,6 +95585,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -95569,6 +95609,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -96292,6 +96340,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -96337,6 +96394,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96355,6 +96421,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -96907,6 +96982,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -96947,6 +97030,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -96963,6 +97054,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98506,6 +98605,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98551,6 +98659,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98569,6 +98686,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -99316,6 +99442,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -99356,6 +99490,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99372,6 +99514,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -100914,6 +101064,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -100954,6 +101112,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -100970,6 +101136,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102015,6 +102189,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102055,6 +102237,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102071,6 +102261,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -103114,6 +103312,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -103154,6 +103360,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -103170,6 +103384,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105484,6 +105706,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105524,6 +105754,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105540,6 +105778,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -107958,6 +108204,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -107998,6 +108252,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -108014,6 +108276,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -108992,6 +109262,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -109032,6 +109310,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -109048,6 +109334,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -224465,6 +224759,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -224505,6 +224807,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -224521,6 +224831,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -225897,6 +226215,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -225937,6 +226263,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -225953,6 +226287,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -226854,6 +227196,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -226894,6 +227244,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -226910,6 +227268,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -335225,6 +335591,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -335265,6 +335639,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -335281,6 +335663,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -336263,6 +336653,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -336303,6 +336701,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -336319,6 +336725,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -337316,6 +337730,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -337356,6 +337778,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -337372,6 +337802,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -338276,6 +338714,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -338316,6 +338762,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -338332,6 +338786,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -339333,6 +339795,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -339373,6 +339843,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -339389,6 +339867,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -340294,6 +340780,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -340334,6 +340828,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -340350,6 +340852,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -341289,6 +341799,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -341329,6 +341847,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -341345,6 +341871,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -342335,6 +342869,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -342375,6 +342917,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -342391,6 +342941,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -345659,6 +346217,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -345699,6 +346265,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -345715,6 +346289,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -361538,6 +362120,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -362530,6 +363161,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -363789,6 +364462,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -365057,6 +365779,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -366054,6 +366825,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -367304,6 +368117,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -491624,6 +492486,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -493183,6 +494094,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -494097,6 +495057,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -495363,6 +496365,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -496641,6 +497692,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -497560,6 +498660,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -498827,6 +499969,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index a8fc4343e116..34b247abc5ef 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -94417,6 +94417,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -94457,6 +94465,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -94473,6 +94489,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95521,6 +95545,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -95561,6 +95593,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -95577,6 +95617,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -96308,6 +96356,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -96353,6 +96410,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96371,6 +96437,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -96932,6 +97007,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -96972,6 +97055,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -96988,6 +97079,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98539,6 +98638,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98584,6 +98692,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98602,6 +98719,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -99358,6 +99484,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -99398,6 +99532,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99414,6 +99556,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -100964,6 +101114,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -101004,6 +101162,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -101020,6 +101186,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102073,6 +102247,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102113,6 +102295,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102129,6 +102319,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -103180,6 +103378,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -103220,6 +103426,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -103236,6 +103450,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105558,6 +105780,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105598,6 +105828,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105614,6 +105852,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -108040,6 +108286,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -108080,6 +108334,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -108096,6 +108358,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -109082,6 +109352,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -109122,6 +109400,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -109138,6 +109424,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -229601,6 +229895,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -229641,6 +229943,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -229657,6 +229967,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -231041,6 +231359,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -231081,6 +231407,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -231097,6 +231431,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -232006,6 +232348,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -232046,6 +232396,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -232062,6 +232420,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -340385,6 +340751,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -340425,6 +340799,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -340441,6 +340823,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -341431,6 +341821,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -341471,6 +341869,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -341487,6 +341893,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -342492,6 +342906,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -342532,6 +342954,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -342548,6 +342978,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -343460,6 +343898,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -343500,6 +343946,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -343516,6 +343970,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -344525,6 +344987,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -344565,6 +345035,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -344581,6 +345059,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -345494,6 +345980,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -345534,6 +346028,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -345550,6 +346052,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -346497,6 +347007,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -346537,6 +347055,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -346553,6 +347079,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -347551,6 +348085,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -347591,6 +348133,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -347607,6 +348157,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -350905,6 +351463,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -350945,6 +351511,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -350961,6 +351535,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -366796,6 +367378,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -367789,6 +368420,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -369049,6 +369722,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -370318,6 +371040,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -371316,6 +372087,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -372567,6 +373380,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -497546,6 +498408,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -499106,6 +500017,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -500021,6 +500981,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -501288,6 +502290,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -502567,6 +503618,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -503487,6 +504587,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -504755,6 +505897,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index bec3ae6bccfa..592d2d6af812 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -94609,6 +94609,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -94649,6 +94657,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -94665,6 +94681,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95713,6 +95737,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -95753,6 +95785,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -95769,6 +95809,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -96500,6 +96548,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -96545,6 +96602,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96563,6 +96629,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -97124,6 +97199,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -97164,6 +97247,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -97180,6 +97271,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98731,6 +98830,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98776,6 +98884,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98794,6 +98911,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -99550,6 +99676,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -99590,6 +99724,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99606,6 +99748,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -101156,6 +101306,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -101196,6 +101354,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -101212,6 +101378,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102265,6 +102439,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102305,6 +102487,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102321,6 +102511,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -103372,6 +103570,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -103412,6 +103618,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -103428,6 +103642,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105750,6 +105972,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105790,6 +106020,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105806,6 +106044,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -108232,6 +108478,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -108272,6 +108526,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -108288,6 +108550,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -109274,6 +109544,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -109314,6 +109592,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -109330,6 +109616,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -230403,6 +230697,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -230443,6 +230745,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -230459,6 +230769,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -231843,6 +232161,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -231883,6 +232209,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -231899,6 +232233,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -232808,6 +233150,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -232848,6 +233198,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -232864,6 +233222,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -341323,6 +341689,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -341363,6 +341737,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -341379,6 +341761,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -342369,6 +342759,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -342409,6 +342807,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -342425,6 +342831,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -343430,6 +343844,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -343470,6 +343892,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -343486,6 +343916,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -344398,6 +344836,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -344438,6 +344884,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -344454,6 +344908,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -345463,6 +345925,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -345503,6 +345973,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -345519,6 +345997,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -346432,6 +346918,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -346472,6 +346966,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -346488,6 +346990,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -347435,6 +347945,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -347475,6 +347993,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -347491,6 +348017,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -348489,6 +349023,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -348529,6 +349071,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -348545,6 +349095,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -351843,6 +352401,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -351883,6 +352449,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -351899,6 +352473,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -368215,6 +368797,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -369335,6 +369966,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -370735,6 +371408,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -372138,6 +372860,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -373263,6 +374034,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -374654,6 +375467,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -495426,6 +496288,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -497224,6 +498135,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -498266,6 +499226,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -499673,6 +500675,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -501086,6 +502137,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -502133,6 +503233,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -503541,6 +504683,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ diff --git a/src/rest/data/ghes-3.18-2022-11-28/schema.json b/src/rest/data/ghes-3.18-2022-11-28/schema.json index cb208e3026d2..8b1ae4d50919 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.18-2022-11-28/schema.json @@ -94689,6 +94689,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -94729,6 +94737,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -94745,6 +94761,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -95793,6 +95817,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -95833,6 +95865,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -95849,6 +95889,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -96580,6 +96628,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -96625,6 +96682,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -96643,6 +96709,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -97204,6 +97279,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -97244,6 +97327,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -97260,6 +97351,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -98811,6 +98910,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "The level of permission to create and retrieve the access token for repository attestations.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -98856,6 +98964,15 @@ "write" ] }, + { + "type": "string", + "name": "discussions", + "description": "The level of permission to grant the access token for discussions and related comments and labels.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "environments", @@ -98874,6 +98991,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -99630,6 +99756,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -99670,6 +99804,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -99686,6 +99828,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -101236,6 +101386,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -101276,6 +101434,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -101292,6 +101458,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -102345,6 +102519,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -102385,6 +102567,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -102401,6 +102591,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -103452,6 +103650,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -103492,6 +103698,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -103508,6 +103722,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -105830,6 +106052,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -105870,6 +106100,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -105886,6 +106124,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -108312,6 +108558,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -108352,6 +108606,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -108368,6 +108630,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -109354,6 +109624,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -109394,6 +109672,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -109410,6 +109696,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -232730,6 +233024,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -232770,6 +233072,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -232786,6 +233096,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -234170,6 +234488,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -234210,6 +234536,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -234226,6 +234560,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -235135,6 +235477,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -235175,6 +235525,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -235191,6 +235549,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -343660,6 +344026,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -343700,6 +344074,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -343716,6 +344098,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -344706,6 +345096,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -344746,6 +345144,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -344762,6 +345168,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -345767,6 +346181,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -345807,6 +346229,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -345823,6 +346253,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -346735,6 +347173,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -346775,6 +347221,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -346791,6 +347245,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -347800,6 +348262,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -347840,6 +348310,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -347856,6 +348334,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -348769,6 +349255,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -348809,6 +349303,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -348825,6 +349327,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -349772,6 +350282,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -349812,6 +350330,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -349828,6 +350354,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -350826,6 +351360,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -350866,6 +351408,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -350882,6 +351432,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -354180,6 +354738,14 @@ "write" ] }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", @@ -354220,6 +354786,14 @@ "write" ] }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", @@ -354236,6 +354810,14 @@ "write" ] }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", @@ -370562,6 +371144,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -371682,6 +372313,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -373082,6 +373755,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -374485,6 +375207,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -375610,6 +376381,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -377001,6 +377814,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -498207,6 +499069,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -500005,6 +500916,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -501047,6 +502007,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -502454,6 +503456,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -503867,6 +504918,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -504914,6 +506014,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -506322,6 +507464,55 @@ "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } } }, "required": [ @@ -517667,17 +518858,6 @@ "publicly_leaked": false, "multi_repo": false, "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, "has_more_locations": true, "assigned_to": { "login": "octocat", @@ -519278,17 +520458,6 @@ "publicly_leaked": false, "multi_repo": false, "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, "has_more_locations": true, "assigned_to": { "login": "octocat", @@ -520836,17 +522005,6 @@ "publicly_leaked": false, "multi_repo": false, "is_base64_encoded": false, - "first_location_detected": { - "path": "/example/secrets.txt", - "start_line": 1, - "end_line": 1, - "start_column": 1, - "end_column": 64, - "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", - "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - }, "has_more_locations": true, "assigned_to": { "login": "octocat", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 367099fda305..f74f2055c4c4 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6" + "sha": "567046173a5469ed9d537d9d3ac397f51f1c6c77" } \ No newline at end of file diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 68b42176c8de..5da4967c25bb 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -4666,6 +4666,30 @@ hasValidityCheck: false base64Supported: false isduplicate: false +- provider: PostHog + supportedSecret: PostHog Feature Flags Secure API Key + secretType: posthog_feature_flags_secure_api_key + versions: + fpt: '*' + ghec: '*' + isPublic: true + isPrivateWithGhas: false + hasPushProtection: false + hasValidityCheck: false + base64Supported: false + isduplicate: false +- provider: PostHog + supportedSecret: PostHog Personal API Key + secretType: posthog_personal_api_key + versions: + fpt: '*' + ghec: '*' + isPublic: true + isPrivateWithGhas: false + hasPushProtection: false + hasValidityCheck: false + base64Supported: false + isduplicate: false - provider: Postman supportedSecret: Postman API Key secretType: postman_api_key @@ -5067,12 +5091,11 @@ base64Supported: false isduplicate: false - provider: Sentry - supportedSecret: Sentry Org Auth Token - secretType: sentry_org_auth_token + supportedSecret: Sentry Organization Token + secretType: sentry_organization_token versions: fpt: '*' ghec: '*' - ghes: '>=3.16' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -5080,12 +5103,11 @@ base64Supported: false isduplicate: false - provider: Sentry - supportedSecret: Sentry User App Auth Token - secretType: sentry_user_app_auth_token + supportedSecret: Sentry Personal Token + secretType: sentry_personal_token versions: fpt: '*' ghec: '*' - ghes: '>=3.16' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -5093,8 +5115,8 @@ base64Supported: false isduplicate: false - provider: Sentry - supportedSecret: Sentry User Auth Token - secretType: sentry_user_auth_token + supportedSecret: Sentry User App Auth Token + secretType: sentry_user_app_auth_token versions: fpt: '*' ghec: '*' diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 97f6487385ee..d5d94eaa733e 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "8c9965bec4e16ea60a2c021127012c5f34a095d9", - "blob-sha": "f560ce57a7f85183d396735a56549990ed1eb114", + "sha": "8ff4c12fe79e4cd591f8464df62701bd700c77fa", + "blob-sha": "63a23e861c756122353370d3c0cd77875be4274c", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index b5159bb3f6af..a4fbedef34a0 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -10798,6 +10798,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -10888,6 +10897,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -10897,6 +10915,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -11704,6 +11731,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -11794,6 +11830,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -11803,6 +11848,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -236780,6 +236834,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -237923,6 +238019,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -239066,6 +239204,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -240180,6 +240360,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -241106,6 +241328,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -242037,6 +242301,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 488b9f74c26e..cee13e3ee544 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -1151,10 +1151,10 @@ "category": "branch_protection_rule" } }, - "bypass_request_push_ruleset": { + "bypass_request_secret_scanning": { "cancelled": { - "descriptionHtml": "A push ruleset bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1507,11 +1507,11 @@ "app" ], "action": "cancelled", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "completed": { - "descriptionHtml": "A push ruleset bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1864,11 +1864,11 @@ "app" ], "action": "completed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "created": { - "descriptionHtml": "A push ruleset bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2221,11 +2221,11 @@ "app" ], "action": "created", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_dismissed": { - "descriptionHtml": "A push ruleset bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2622,11 +2622,11 @@ "app" ], "action": "response_dismissed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -3023,2532 +3023,657 @@ "app" ], "action": "response_submitted", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" } }, - "bypass_request_secret_scanning": { - "cancelled": { - "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", + "check_run": { + "completed": { + "descriptionHtml": "A check run was completed, and a conclusion is available.
", + "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
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.\"
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 request from a user to be exempted from a set of rules.
", + "description": "A check performed on the code of a given code change
", "isRequired": true, "childParamsGroups": [ { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", + "type": "object or null", + "name": "app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", + "isRequired": true, "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, { "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", + "name": "owner", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], "childParamsGroups": [ { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" }, { "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" + "name": "login", + "description": "", + "isRequired": true }, { "type": "integer", - "name": "total_violations", - "description": "The number of violations
" + "name": "id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ + "name": "node_id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" + "name": "avatar_url", + "description": "", + "isRequired": true }, { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, { "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] + "name": "url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" + "name": "html_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" } ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] }, { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", + "type": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, { "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true } ] } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ + ], + "oneOfObject": true + }, { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true }, { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true }, { "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" + "name": "external_url", + "description": "", + "isRequired": true }, { "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] + "name": "html_url", + "description": "", + "isRequired": true }, { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true }, { "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "cancelled", - "category": "bypass_request_secret_scanning" - }, - "completed": { - "descriptionHtml": "A secret scanning bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ + "name": "updated_at", + "description": "", + "isRequired": true + }, { "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, "childParamsGroups": [ { "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] + "name": "issues", + "description": "" }, { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" } ] }, { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" + } + ] + }, + { + "type": "object", + "name": "check_suite", + "description": "A suite of checks performed on the code of a given code change
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "after", + "description": "" + }, + { + "type": "object or null", + "name": "app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, { "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] + "name": "slug", + "description": "The slug name of the GitHub app
" }, { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" + "type": "object", + "name": "Simple User", + "description": "A GitHub user.
", + "isRequired": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] }, { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", + "type": "object", + "name": "Enterprise", + "description": "An enterprise on GitHub.
", + "isRequired": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ], "childParamsGroups": [ + { + "type": "string or null", + "name": "description", + "description": "A short description of the enterprise.
" + }, { "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "website_url", + "description": "The enterprise's website URL.
" + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the enterprise
", + "isRequired": true }, { "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" + "name": "node_id", + "description": "", + "isRequired": true }, { "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" + "name": "name", + "description": "The name of the enterprise.
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug url identifier for the enterprise.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true } ] } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "bypass_request_secret_scanning" - }, - "created": { - "descriptionHtml": "A secret scanning push protection bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "bypass_request_secret_scanning" - }, - "response_dismissed": { - "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_dismissed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_dismissed", - "category": "bypass_request_secret_scanning" - }, - "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_submitted" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_submitted", - "category": "bypass_request_secret_scanning" - } - }, - "check_run": { - "completed": { - "descriptionHtml": "A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.
A check performed on the code of a given code change
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object or null", - "name": "app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "A GitHub user.
", - "isRequired": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "An enterprise on GitHub.
", - "isRequired": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ], - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "A short description of the enterprise.
" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "The enterprise's website URL.
" - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the enterprise
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the enterprise.
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug url identifier for the enterprise.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the GitHub app
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "external_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "permissions", - "description": "The set of permissions for the GitHub app
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "issues", - "description": "" - }, - { - "type": "string", - "name": "checks", - "description": "" - }, - { - "type": "string", - "name": "metadata", - "description": "" - }, - { - "type": "string", - "name": "contents", - "description": "" - }, - { - "type": "string", - "name": "deployments", - "description": "" - } - ] - }, - { - "type": "array of strings", - "name": "events", - "description": "The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
" - } - ] - }, - { - "type": "object", - "name": "check_suite", - "description": "A suite of checks performed on the code of a given code change
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string or null", - "name": "after", - "description": "" - }, - { - "type": "object or null", - "name": "app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the GitHub app
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug name of the GitHub app
" - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "client_id", - "description": "" - }, - { - "type": "object", - "name": "owner", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "Simple User", - "description": "A GitHub user.
", - "isRequired": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "object", - "name": "Enterprise", - "description": "An enterprise on GitHub.
", - "isRequired": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ], - "childParamsGroups": [ - { - "type": "string or null", - "name": "description", - "description": "A short description of the enterprise.
" - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "website_url", - "description": "The enterprise's website URL.
" - }, - { - "type": "integer", - "name": "id", - "description": "Unique identifier of the enterprise
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the enterprise.
", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "The slug url identifier for the enterprise.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "updated_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - } - ] - } - ], - "oneOfObject": true - }, + ], + "oneOfObject": true + }, { "type": "string", "name": "name", @@ -14612,6 +12737,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -14702,6 +12836,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -14711,6 +12854,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -15518,6 +13670,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -15608,6 +13769,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -15617,6 +13787,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -48415,17 +46594,914 @@ }, { "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.\"
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.\"
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": "transferred", + "category": "discussion" + }, + "unanswered": { + "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "old_answer", "in": "body", - "description": "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.\"
How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] }, { "type": "object", @@ -48447,7 +47523,6 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, "childParamsGroups": [] } ], @@ -48456,11 +47531,11 @@ "organization", "app" ], - "action": "transferred", + "action": "unanswered", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "unlabeled": { + "descriptionHtml": "A label was removed from a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nAn 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.\"
6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. 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": "unlabeled", + "category": "discussion" + }, + "unlocked": { + "descriptionHtml": "A discussion was unlocked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, { "type": "string", "name": "author_association", @@ -49077,20 +48407,81 @@ "isRequired": true }, { - "type": "integer", - "name": "child_comment_count", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "created_at", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, @@ -49106,6 +48497,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, { "type": "string", "name": "node_id", @@ -49113,8 +48510,8 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -49191,6 +48588,43 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, { "type": "string", "name": "updated_at", @@ -49321,9 +48755,72 @@ "description": "" } ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] } ] }, + { + "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.\"
A GitHub user.
", + "isRequired": true, "childParamsGroups": [] } ], @@ -49352,11 +48850,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "unlocked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "A label was removed from a discussion.
", + "unpinned": { + "descriptionHtml": "A discussion was unpinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe 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.\"
6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -50037,12 +49484,14 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unpinned", "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "A discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "action": "deleted", + "category": "discussion_comment" + }, + "edited": { + "descriptionHtml": "A comment on a discussion was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nUnique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "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.\"
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": "edited", + "category": "discussion_comment" + } + }, + "dismissal_request_code_scanning": { + "created": { + "descriptionHtml": "A code scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "array of objects", - "name": "labels", - "description": "", + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA code scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -51963,620 +51808,738 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "response_submitted" ], "childParamsGroups": [] }, { "type": "object", - "name": "comment", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, + "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.\"
A Discussion in a repository.
", + "description": "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.\"
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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "object or null", - "name": "answer_chosen_by", + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] + ], + "oneOfObject": true }, { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, + "name": "status", + "description": "The status of the exemption request.
", "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "pending", + "rejected", + "cancelled", + "completed" ] }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "A response to an exemption request by a delegated bypasser.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, { "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "response_submitted", + "category": "dismissal_request_code_scanning" + } + }, + "dismissal_request_secret_scanning": { + "cancelled": { + "descriptionHtml": "A secret scanning alert dismissal request was canceled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "", - "isRequired": true + "description": "The ID of the exemption request.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "reactions", + "name": "exemption_request_data", "description": "", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] + ], + "oneOfObject": true }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "type", - "description": "", + "name": "status", + "description": "The status of the exemption response.
", "enum": [ - "Bot", - "User", - "Organization" + "approved", + "rejected", + "dismissed" ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "user_view_type", - "description": "" + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier for 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": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true - } - ] + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA secret scanning alert dismissal request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -52605,614 +52568,367 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "completed" ], "childParamsGroups": [] }, { "type": "object", - "name": "changes", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] + "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.\"
A Discussion in a repository.
", + "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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, { "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "reactions", + "name": "exemption_request_data", "description": "", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] + ], + "oneOfObject": true }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The status of the exemption request.
", "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "pending", + "rejected", + "cancelled", + "completed" ] }, { "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "type", - "description": "", + "name": "status", + "description": "The status of the exemption response.
", "enum": [ - "Bot", - "User", - "Organization" + "approved", + "rejected", + "dismissed" ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "user_view_type", - "description": "" + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier for 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": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true - } - ] + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "dismissal_request_secret_scanning" + }, + "created": { + "descriptionHtml": "A secret scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "enterprise", @@ -53239,9 +52955,305 @@ "name": "repository", "in": "body", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, { "type": "object", "name": "sender", @@ -53256,14 +53268,12 @@ "organization", "app" ], - "action": "edited", - "category": "discussion_comment" - } - }, - "dismissal_request_code_scanning": { - "created": { - "descriptionHtml": "A code scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "action": "created", + "category": "dismissal_request_secret_scanning" + }, + "response_dismissed": { + "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -53272,7 +53282,7 @@ "description": "", "isRequired": true, "enum": [ - "created" + "response_dismissed" ], "childParamsGroups": [] }, @@ -53601,6 +53611,50 @@ } ] }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "A response to an exemption request by a delegated bypasser.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, { "type": "object", "name": "sender", @@ -53615,12 +53669,12 @@ "organization", "app" ], - "action": "created", - "category": "dismissal_request_code_scanning" + "action": "response_dismissed", + "category": "dismissal_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A code scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -54017,13 +54071,13 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_code_scanning" + "category": "dismissal_request_secret_scanning" } }, - "dismissal_request_secret_scanning": { + "exemption_request_push_ruleset": { "cancelled": { - "descriptionHtml": "A secret scanning alert dismissal request was canceled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54376,11 +54430,11 @@ "app" ], "action": "cancelled", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "completed": { - "descriptionHtml": "A secret scanning alert dismissal request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54733,11 +54787,11 @@ "app" ], "action": "completed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "created": { - "descriptionHtml": "A secret scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55090,11 +55144,11 @@ "app" ], "action": "created", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_dismissed": { - "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55491,11 +55545,11 @@ "app" ], "action": "response_dismissed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_submitted": { - "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55892,7 +55946,7 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" } }, "fork": { @@ -243608,6 +243662,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -244752,6 +244848,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -245896,6 +246034,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -247010,6 +247190,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -247936,6 +248158,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -248867,6 +249131,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 43f14306bd88..6ed68107747f 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -12420,6 +12420,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -12510,6 +12519,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -12519,6 +12537,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -13326,6 +13353,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -13416,6 +13452,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -13425,6 +13470,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -201963,6 +202017,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -202856,6 +202952,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -203749,6 +203887,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -204617,6 +204797,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -205297,6 +205519,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -205982,6 +206246,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 6b9b301380cc..f7f18d82d5d6 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -12603,6 +12603,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -12693,6 +12702,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -12702,6 +12720,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -13509,6 +13536,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -13599,6 +13635,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -13608,6 +13653,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -202223,6 +202277,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -203229,6 +203325,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -204235,6 +204373,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -205216,6 +205396,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -206009,6 +206231,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -206807,6 +207071,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 9b60702734f2..5c3f93a7ed16 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -1151,10 +1151,10 @@ "category": "branch_protection_rule" } }, - "bypass_request_push_ruleset": { + "bypass_request_secret_scanning": { "cancelled": { - "descriptionHtml": "A push ruleset bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1507,11 +1507,11 @@ "app" ], "action": "cancelled", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "completed": { - "descriptionHtml": "A push ruleset bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1864,11 +1864,11 @@ "app" ], "action": "completed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "created": { - "descriptionHtml": "A push ruleset bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2221,11 +2221,11 @@ "app" ], "action": "created", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_dismissed": { - "descriptionHtml": "A push ruleset bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2622,11 +2622,11 @@ "app" ], "action": "response_dismissed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -3023,1909 +3023,34 @@ "app" ], "action": "response_submitted", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" } }, - "bypass_request_secret_scanning": { - "cancelled": { - "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", + "cache_sync": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", - "name": "action", + "name": "after", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] + "description": "", + "isRequired": true }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "cancelled", - "category": "bypass_request_secret_scanning" - }, - "completed": { - "descriptionHtml": "A secret scanning bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ { "type": "string", - "name": "action", + "name": "cache_location", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "bypass_request_secret_scanning" - }, - "created": { - "descriptionHtml": "A secret scanning push protection bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "bypass_request_secret_scanning" - }, - "response_dismissed": { - "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_dismissed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_dismissed", - "category": "bypass_request_secret_scanning" - }, - "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_submitted" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_submitted", - "category": "bypass_request_secret_scanning" - } - }, - "cache_sync": { - "default": { - "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "after", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cache_location", - "in": "body", - "description": "", - "isRequired": true + "isRequired": true }, { "type": "object", @@ -14478,6 +12603,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -14568,6 +12702,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -14577,6 +12720,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -15384,6 +13536,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -15474,6 +13635,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -15483,6 +13653,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -48081,17 +46260,914 @@ }, { "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.\"
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.\"
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": "transferred", + "category": "discussion" + }, + "unanswered": { + "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "old_answer", "in": "body", - "description": "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.\"
How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] }, { "type": "object", @@ -48113,7 +47189,6 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, "childParamsGroups": [] } ], @@ -48122,11 +47197,11 @@ "organization", "app" ], - "action": "transferred", + "action": "unanswered", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "unlabeled": { + "descriptionHtml": "A label was removed from a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nAn 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.\"
6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. 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": "unlabeled", + "category": "discussion" + }, + "unlocked": { + "descriptionHtml": "A discussion was unlocked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, { "type": "string", "name": "author_association", @@ -48743,20 +48073,81 @@ "isRequired": true }, { - "type": "integer", - "name": "child_comment_count", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "created_at", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, @@ -48772,6 +48163,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, { "type": "string", "name": "node_id", @@ -48779,8 +48176,8 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -48857,6 +48254,43 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, { "type": "string", "name": "updated_at", @@ -48987,9 +48421,72 @@ "description": "" } ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] } ] }, + { + "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.\"
A GitHub user.
", + "isRequired": true, "childParamsGroups": [] } ], @@ -49018,11 +48516,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "unlocked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "A label was removed from a discussion.
", + "unpinned": { + "descriptionHtml": "A discussion was unpinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe 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.\"
6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -49703,12 +49150,14 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unpinned", "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "A discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "action": "deleted", + "category": "discussion_comment" + }, + "edited": { + "descriptionHtml": "A comment on a discussion was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nUnique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "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.\"
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": "edited", + "category": "discussion_comment" + } + }, + "enterprise": { + "anonymous_access_disabled": { + "descriptionHtml": "Anonymous Git read access was disabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_disabled", + "category": "enterprise" + }, + "anonymous_access_enabled": { + "descriptionHtml": "Anonymous Git read access was enabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_enabled", + "category": "enterprise" + } + }, + "exemption_request_push_ruleset": { + "cancelled": { + "descriptionHtml": "A push ruleset bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "array of objects", - "name": "labels", - "description": "", + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA push ruleset bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -51629,620 +51534,692 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "completed" ], "childParamsGroups": [] }, { "type": "object", - "name": "comment", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, + "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.\"
A Discussion in a repository.
", + "description": "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.\"
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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "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" - ] + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "category", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + ], + "oneOfObject": true }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object", - "name": "reactions", - "description": "", + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "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 + "name": "id", + "description": "The ID of the exemption response.
" }, { "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "completed", + "category": "exemption_request_push_ruleset" + }, + "created": { + "descriptionHtml": "A push ruleset bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. 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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "array of objects", - "name": "labels", - "description": "", + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA push ruleset bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -52271,614 +52248,411 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "response_dismissed" ], "childParamsGroups": [] }, { "type": "object", - "name": "changes", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] + "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.\"
A Discussion in a repository.
", + "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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "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" - ] + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "category", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + ], + "oneOfObject": true }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object", - "name": "reactions", - "description": "", + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "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 + "name": "id", + "description": "The ID of the exemption response.
" }, { "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "A response to an exemption request by a delegated bypasser.
", + "isRequired": true, + "childParamsGroups": [ { - "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier for 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": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true - } - ] + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "response_dismissed", + "category": "exemption_request_push_ruleset" + }, + "response_submitted": { + "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "response_submitted" + ], + "childParamsGroups": [] + }, { "type": "object", "name": "enterprise", @@ -52905,85 +52679,365 @@ "name": "repository", "in": "body", "description": "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": "edited", - "category": "discussion_comment" - } - }, - "enterprise": { - "anonymous_access_disabled": { - "descriptionHtml": "Anonymous Git read access was disabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "exemption_request", "in": "body", - "description": "", + "description": "A request from a user to be exempted from a set of rules.
", "isRequired": true, - "enum": [ - "anonymous_access_disabled" - ], - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] }, { "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_disabled", - "category": "enterprise" - }, - "anonymous_access_enabled": { - "descriptionHtml": "Anonymous Git read access was enabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", + "name": "exemption_response", "in": "body", - "description": "", + "description": "A response to an exemption request by a delegated bypasser.
", "isRequired": true, - "enum": [ - "anonymous_access_enabled" - ], - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] }, { "type": "object", "name": "sender", "in": "body", "description": "A GitHub user.
", + "isRequired": true, "childParamsGroups": [] } ], "availability": [ - "business" + "repository", + "organization", + "app" ], - "action": "anonymous_access_enabled", - "category": "enterprise" + "action": "response_submitted", + "category": "exemption_request_push_ruleset" } }, "fork": { @@ -204228,6 +204282,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -205235,6 +205331,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -206242,6 +206380,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -207223,6 +207403,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -208016,6 +208238,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -208814,6 +209078,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index c9299e4c2bb1..647631ee6b86 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -1151,10 +1151,10 @@ "category": "branch_protection_rule" } }, - "bypass_request_push_ruleset": { + "bypass_request_secret_scanning": { "cancelled": { - "descriptionHtml": "A push ruleset bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1507,11 +1507,11 @@ "app" ], "action": "cancelled", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "completed": { - "descriptionHtml": "A push ruleset bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1864,11 +1864,11 @@ "app" ], "action": "completed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "created": { - "descriptionHtml": "A push ruleset bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2221,11 +2221,11 @@ "app" ], "action": "created", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_dismissed": { - "descriptionHtml": "A push ruleset bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2622,11 +2622,11 @@ "app" ], "action": "response_dismissed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -3023,1909 +3023,34 @@ "app" ], "action": "response_submitted", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" } }, - "bypass_request_secret_scanning": { - "cancelled": { - "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", + "cache_sync": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", - "name": "action", + "name": "after", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] + "description": "", + "isRequired": true }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "cancelled", - "category": "bypass_request_secret_scanning" - }, - "completed": { - "descriptionHtml": "A secret scanning bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ { "type": "string", - "name": "action", + "name": "cache_location", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "bypass_request_secret_scanning" - }, - "created": { - "descriptionHtml": "A secret scanning push protection bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "bypass_request_secret_scanning" - }, - "response_dismissed": { - "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_dismissed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_dismissed", - "category": "bypass_request_secret_scanning" - }, - "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_submitted" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_submitted", - "category": "bypass_request_secret_scanning" - } - }, - "cache_sync": { - "default": { - "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "after", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cache_location", - "in": "body", - "description": "", - "isRequired": true + "isRequired": true }, { "type": "object", @@ -14542,6 +12667,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -14632,6 +12766,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -14641,6 +12784,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -15448,6 +13600,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -15538,6 +13699,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -15547,6 +13717,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -48145,17 +46324,914 @@ }, { "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.\"
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.\"
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": "transferred", + "category": "discussion" + }, + "unanswered": { + "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "old_answer", "in": "body", - "description": "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.\"
How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] }, { "type": "object", @@ -48177,7 +47253,6 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, "childParamsGroups": [] } ], @@ -48186,11 +47261,11 @@ "organization", "app" ], - "action": "transferred", + "action": "unanswered", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "unlabeled": { + "descriptionHtml": "A label was removed from a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nAn 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.\"
6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. 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": "unlabeled", + "category": "discussion" + }, + "unlocked": { + "descriptionHtml": "A discussion was unlocked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, { "type": "string", "name": "author_association", @@ -48807,20 +48137,81 @@ "isRequired": true }, { - "type": "integer", - "name": "child_comment_count", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "created_at", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, @@ -48836,6 +48227,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, { "type": "string", "name": "node_id", @@ -48843,8 +48240,8 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -48921,6 +48318,43 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, { "type": "string", "name": "updated_at", @@ -49051,9 +48485,72 @@ "description": "" } ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] } ] }, + { + "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.\"
A GitHub user.
", + "isRequired": true, "childParamsGroups": [] } ], @@ -49082,11 +48580,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "unlocked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "A label was removed from a discussion.
", + "unpinned": { + "descriptionHtml": "A discussion was unpinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe 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.\"
6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -49767,12 +49214,14 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unpinned", "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "A discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "action": "deleted", + "category": "discussion_comment" + }, + "edited": { + "descriptionHtml": "A comment on a discussion was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nUnique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "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.\"
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": "edited", + "category": "discussion_comment" + } + }, + "dismissal_request_code_scanning": { + "created": { + "descriptionHtml": "A code scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "dismissal_request_code_scanning" + }, + "response_submitted": { + "descriptionHtml": "A code scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "response_submitted" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, { "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.\"
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 response to an exemption request by a delegated bypasser.
", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] }, { "type": "object", @@ -51679,12 +51925,14 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" - }, - "deleted": { - "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA secret scanning alert dismissal request was canceled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -51693,620 +51941,692 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "cancelled" ], "childParamsGroups": [] }, { "type": "object", - "name": "comment", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, + "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.\"
A Discussion in a repository.
", + "description": "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.\"
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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "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" - ] + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "category", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + ], + "oneOfObject": true }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object", - "name": "reactions", - "description": "", + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "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 + "name": "id", + "description": "The ID of the exemption response.
" }, { "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "cancelled", + "category": "dismissal_request_secret_scanning" + }, + "completed": { + "descriptionHtml": "A secret scanning alert dismissal request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "completed" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } ] }, { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "array of objects", - "name": "labels", - "description": "", + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA secret scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -52335,643 +52655,335 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "created" ], "childParamsGroups": [] }, { "type": "object", - "name": "changes", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] + "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.\"
A Discussion in a repository.
", + "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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, { "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "reactions", + "name": "exemption_request_data", "description": "", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] + ], + "oneOfObject": true }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The status of the exemption request.
", "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "pending", + "rejected", + "cancelled", + "completed" ] }, { "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "type", - "description": "", + "name": "status", + "description": "The status of the exemption response.
", "enum": [ - "Bot", - "User", - "Organization" + "approved", + "rejected", + "dismissed" ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "user_view_type", - "description": "" + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier for 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": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true - } - ] + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 code scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "action": "created", + "category": "dismissal_request_secret_scanning" + }, + "response_dismissed": { + "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -53002,7 +53012,7 @@ "description": "", "isRequired": true, "enum": [ - "created" + "response_dismissed" ], "childParamsGroups": [] }, @@ -53331,6 +53341,50 @@ } ] }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "A response to an exemption request by a delegated bypasser.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, { "type": "object", "name": "sender", @@ -53345,12 +53399,12 @@ "organization", "app" ], - "action": "created", - "category": "dismissal_request_code_scanning" + "action": "response_dismissed", + "category": "dismissal_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A code scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -53747,13 +53801,73 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_code_scanning" + "category": "dismissal_request_secret_scanning" } }, - "dismissal_request_secret_scanning": { + "enterprise": { + "anonymous_access_disabled": { + "descriptionHtml": "Anonymous Git read access was disabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_disabled", + "category": "enterprise" + }, + "anonymous_access_enabled": { + "descriptionHtml": "Anonymous Git read access was enabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_enabled", + "category": "enterprise" + } + }, + "exemption_request_push_ruleset": { "cancelled": { - "descriptionHtml": "A secret scanning alert dismissal request was canceled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54106,11 +54220,11 @@ "app" ], "action": "cancelled", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "completed": { - "descriptionHtml": "A secret scanning alert dismissal request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54463,11 +54577,11 @@ "app" ], "action": "completed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "created": { - "descriptionHtml": "A secret scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54820,11 +54934,11 @@ "app" ], "action": "created", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_dismissed": { - "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55221,11 +55335,11 @@ "app" ], "action": "response_dismissed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_submitted": { - "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55622,67 +55736,7 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_secret_scanning" - } - }, - "enterprise": { - "anonymous_access_disabled": { - "descriptionHtml": "Anonymous Git read access was disabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_disabled", - "category": "enterprise" - }, - "anonymous_access_enabled": { - "descriptionHtml": "Anonymous Git read access was enabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_enabled", - "category": "enterprise" + "category": "exemption_request_push_ruleset" } }, "fork": { @@ -206932,6 +206986,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -208072,6 +208168,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -209212,6 +209350,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -210326,6 +210506,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -211252,6 +211474,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -212183,6 +212447,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/data/ghes-3.18/schema.json b/src/webhooks/data/ghes-3.18/schema.json index 1095a612315b..b8f3f1e18fc4 100644 --- a/src/webhooks/data/ghes-3.18/schema.json +++ b/src/webhooks/data/ghes-3.18/schema.json @@ -1151,10 +1151,10 @@ "category": "branch_protection_rule" } }, - "bypass_request_push_ruleset": { + "bypass_request_secret_scanning": { "cancelled": { - "descriptionHtml": "A push ruleset bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1507,11 +1507,11 @@ "app" ], "action": "cancelled", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "completed": { - "descriptionHtml": "A push ruleset bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -1864,11 +1864,11 @@ "app" ], "action": "completed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "created": { - "descriptionHtml": "A push ruleset bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2221,11 +2221,11 @@ "app" ], "action": "created", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_dismissed": { - "descriptionHtml": "A push ruleset bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -2622,11 +2622,11 @@ "app" ], "action": "response_dismissed", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -3023,1909 +3023,34 @@ "app" ], "action": "response_submitted", - "category": "bypass_request_push_ruleset" + "category": "bypass_request_secret_scanning" } }, - "bypass_request_secret_scanning": { - "cancelled": { - "descriptionHtml": "A secret scanning push protection bypass request was cancelled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", + "cache_sync": { + "default": { + "descriptionHtml": "", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", - "name": "action", + "name": "after", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "cancelled" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] + "description": "", + "isRequired": true }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "cancelled", - "category": "bypass_request_secret_scanning" - }, - "completed": { - "descriptionHtml": "A secret scanning bypass request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ { "type": "string", - "name": "action", + "name": "cache_location", "in": "body", "description": "", - "isRequired": true, - "enum": [ - "completed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "completed", - "category": "bypass_request_secret_scanning" - }, - "created": { - "descriptionHtml": "A secret scanning push protection bypass request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "created" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "created", - "category": "bypass_request_secret_scanning" - }, - "response_dismissed": { - "descriptionHtml": "A secret scanning push protection bypass response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_dismissed" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_dismissed", - "category": "bypass_request_secret_scanning" - }, - "response_submitted": { - "descriptionHtml": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.
\nFor more information, see \"Enabling delegated bypass for push protection.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\nNote: Delegated bypass for push protection is currently in public preview and subject to change.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "response_submitted" - ], - "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.\"
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 request from a user to be exempted from a set of rules.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption request.
" - }, - { - "type": "integer or null", - "name": "number", - "description": "The number uniquely identifying the exemption request within it's repository.
" - }, - { - "type": "integer", - "name": "repository_id", - "description": "The ID of the repository the exemption request is for.
" - }, - { - "type": "integer", - "name": "requester_id", - "description": "The ID of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "requester_login", - "description": "The login of the user who requested the exemption.
" - }, - { - "type": "string", - "name": "request_type", - "description": "The type of request.
", - "enum": [ - "push_ruleset_bypass", - "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" - ] - }, - { - "type": "object", - "name": "exemption_request_data", - "description": "", - "childParamsGroups": [ - { - "type": "object", - "name": "Push ruleset bypass exemption request data", - "description": "Push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "push_ruleset_bypass" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the push rules that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "ruleset_id", - "description": "The ID of the ruleset for the rules that were violated
" - }, - { - "type": "string", - "name": "ruleset_name", - "description": "The name of the ruleset for the rules that were violated
" - }, - { - "type": "integer", - "name": "total_violations", - "description": "The number of violations
" - }, - { - "type": "string", - "name": "rule_type", - "description": "The type of rule that was violated
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning push protection exemption request data", - "description": "Secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", - "childParamsGroups": [ - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "array of objects", - "name": "locations", - "description": "The location data of the secret that was detected
", - "childParamsGroups": [ - { - "type": "string", - "name": "commit", - "description": "The commit SHA where the secret was detected
" - }, - { - "type": "string", - "name": "branch", - "description": "The branch where the secret was detected
" - }, - { - "type": "string", - "name": "path", - "description": "The path of the file where the secret was detected
" - } - ] - } - ] - } - ] - }, - { - "type": "object", - "name": "Secret scanning alert dismissal request data", - "description": "Secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "secret_scanning_closure" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the secret scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "reason", - "description": "The reason for the dismissal request
", - "enum": [ - "fixed_later", - "false_positive", - "tests", - "revoked" - ] - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that was detected
" - }, - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert that was detected
" - } - ] - } - ] - }, - { - "type": "object", - "name": "Code scanning alert dismissal request data", - "description": "Code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "type", - "description": "The type of request
", - "enum": [ - "code_scanning_alert_dismissal" - ] - }, - { - "type": "array of objects", - "name": "data", - "description": "The data related to the code scanning alerts that have dismissal requests.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alert_number", - "description": "The number of the alert to be dismissed
" - } - ] - } - ] - } - ], - "oneOfObject": true - }, - { - "type": "string", - "name": "resource_identifier", - "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption request.
", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - { - "type": "string or null", - "name": "requester_comment", - "description": "The comment the requester provided when creating the exemption request.
" - }, - { - "type": "object or null", - "name": "metadata", - "description": "Metadata about the exemption request.
" - }, - { - "type": "string", - "name": "expires_at", - "description": "The date and time the exemption request will expire.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - }, - { - "type": "array of objects or null", - "name": "responses", - "description": "The responses to the exemption request.
", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "string", - "name": "html_url", - "description": "The URL to view the exemption request in a browser.
" - } - ] - }, - { - "type": "object", - "name": "exemption_response", - "in": "body", - "description": "A response to an exemption request by a delegated bypasser.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "The ID of the exemption response.
" - }, - { - "type": "integer", - "name": "reviewer_id", - "description": "The ID of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "reviewer_login", - "description": "The login of the user who reviewed the exemption request.
" - }, - { - "type": "string", - "name": "status", - "description": "The status of the exemption response.
", - "enum": [ - "approved", - "rejected", - "dismissed" - ] - }, - { - "type": "string or null", - "name": "reviewer_comment", - "description": "The comment the reviewer provided when responding to the exemption request.
" - }, - { - "type": "string", - "name": "created_at", - "description": "The date and time the exemption request was created.
" - } - ] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "response_submitted", - "category": "bypass_request_secret_scanning" - } - }, - "cache_sync": { - "default": { - "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "after", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "before", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "cache_location", - "in": "body", - "description": "", - "isRequired": true + "isRequired": true }, { "type": "object", @@ -14562,6 +12687,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -14652,6 +12786,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -14661,6 +12804,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -15468,6 +13620,15 @@ "write" ] }, + { + "type": "string", + "name": "attestations", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "checks", @@ -15558,6 +13719,15 @@ "write" ] }, + { + "type": "string", + "name": "merge_queues", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "metadata", @@ -15567,6 +13737,15 @@ "write" ] }, + { + "type": "string", + "name": "models", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_administration", @@ -48288,17 +46467,914 @@ }, { "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.\"
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.\"
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": "transferred", + "category": "discussion" + }, + "unanswered": { + "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "category", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "old_answer", "in": "body", - "description": "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.\"
How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "string", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "child_comment_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "discussion_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "null", + "name": "parent_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "reactions", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "+1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "-1", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "confused", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "eyes", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "heart", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "hooray", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "laugh", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "rocket", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "total_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] }, { "type": "object", @@ -48320,7 +47396,6 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, "childParamsGroups": [] } ], @@ -48329,11 +47404,11 @@ "organization", "app" ], - "action": "transferred", + "action": "unanswered", "category": "discussion" }, - "unanswered": { - "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", + "unlabeled": { + "descriptionHtml": "A label was removed from a discussion.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nAn 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.\"
6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the label
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization. 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": "unlabeled", + "category": "discussion" + }, + "unlocked": { + "descriptionHtml": "A discussion was unlocked.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA Discussion in a repository.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "active_lock_reason", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "answer_chosen_at", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "answer_chosen_by", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "answer_html_url", + "description": "", + "isRequired": true + }, { "type": "string", "name": "author_association", @@ -48950,20 +48280,81 @@ "isRequired": true }, { - "type": "integer", - "name": "child_comment_count", + "type": "object", + "name": "category", "description": "", - "isRequired": true + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "emoji", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_answerable", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "integer", + "name": "repository_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + } + ] }, { - "type": "string", - "name": "created_at", + "type": "integer", + "name": "comments", "description": "", "isRequired": true }, { - "type": "integer", - "name": "discussion_id", + "type": "string", + "name": "created_at", "description": "", "isRequired": true }, @@ -48979,6 +48370,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "locked", + "description": "", + "isRequired": true + }, { "type": "string", "name": "node_id", @@ -48986,8 +48383,8 @@ "isRequired": true }, { - "type": "null", - "name": "parent_id", + "type": "integer", + "name": "number", "description": "", "isRequired": true }, @@ -49064,6 +48461,43 @@ "description": "", "isRequired": true }, + { + "type": "string", + "name": "state", + "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The reason for the current state
", + "isRequired": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened", + null + ] + }, + { + "type": "string", + "name": "timeline_url", + "description": "" + }, + { + "type": "string", + "name": "title", + "description": "", + "isRequired": true + }, { "type": "string", "name": "updated_at", @@ -49194,9 +48628,72 @@ "description": "" } ] + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] } ] }, + { + "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.\"
A GitHub user.
", + "isRequired": true, "childParamsGroups": [] } ], @@ -49225,11 +48723,11 @@ "organization", "app" ], - "action": "unanswered", + "action": "unlocked", "category": "discussion" }, - "unlabeled": { - "descriptionHtml": "A label was removed from a discussion.
", + "unpinned": { + "descriptionHtml": "A discussion was unpinned.
", "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nThe 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.\"
6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true - } - ] - }, { "type": "object", "name": "organization", @@ -49910,12 +49357,14 @@ "organization", "app" ], - "action": "unlabeled", + "action": "unpinned", "category": "discussion" - }, - "unlocked": { - "descriptionHtml": "A discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was deleted.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA comment on a discussion was created.
", + "action": "deleted", + "category": "discussion_comment" + }, + "edited": { + "descriptionHtml": "A comment on a discussion was edited.
", "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nUnique identifier for 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": "name", + "description": "The name of the label.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Optional description of the label, such as its purpose.
", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "6-character hex code, without the leading #, identifying the color
", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "Whether this label comes by default in a new repository.
", + "isRequired": true + } + ] + } + ] + }, + { + "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.\"
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": "edited", + "category": "discussion_comment" + } + }, + "dismissal_request_code_scanning": { + "created": { + "descriptionHtml": "A code scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "created", + "category": "dismissal_request_code_scanning" + }, + "response_submitted": { + "descriptionHtml": "A code scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "response_submitted" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" + }, + { + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" + }, + { + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" + }, + { + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" + }, + { + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + { + "type": "object", + "name": "exemption_request_data", + "description": "", + "childParamsGroups": [ + { + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] + }, + { + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] + }, + { + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] + } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + { + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, { "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.\"
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 response to an exemption request by a delegated bypasser.
", "isRequired": true, - "childParamsGroups": [] + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] }, { "type": "object", @@ -51822,12 +52068,14 @@ "organization", "app" ], - "action": "created", - "category": "discussion_comment" - }, - "deleted": { - "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA secret scanning alert dismissal request was canceled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -51836,620 +52084,692 @@ "description": "", "isRequired": true, "enum": [ - "deleted" + "cancelled" ], "childParamsGroups": [] }, { "type": "object", - "name": "comment", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, + "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.\"
A Discussion in a repository.
", + "description": "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.\"
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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "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" - ] + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "body", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "category", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] - }, - { - "type": "integer", - "name": "comments", - "description": "", - "isRequired": true + ], + "oneOfObject": true }, { "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object", - "name": "reactions", - "description": "", + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "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 + "name": "id", + "description": "The ID of the exemption response.
" }, { "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "url", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" + } + ] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "cancelled", + "category": "dismissal_request_secret_scanning" + }, + "completed": { + "descriptionHtml": "A secret scanning alert dismissal request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "completed" + ], + "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.\"
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 request from a user to be exempted from a set of rules.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The number uniquely identifying the exemption request within it's repository.
" }, { - "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "type": "integer", + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { - "type": "object or null", - "name": "user", + "type": "object", + "name": "exemption_request_data", "description": "", - "isRequired": true, "childParamsGroups": [ { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "string", - "name": "subscriptions_url", - "description": "" + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } ] }, { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } + ], + "oneOfObject": true + }, + { + "type": "string", + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption request.
", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" ] }, { - "type": "array of objects", - "name": "labels", - "description": "", + "type": "string or null", + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" + }, + { + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" + }, + { + "type": "string", + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + }, + { + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ { "type": "integer", "name": "id", - "description": "Unique identifier for the label.
", - "isRequired": true + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "url", - "description": "URL for the label
", - "isRequired": true + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "name", - "description": "The name of the label.
", - "isRequired": true + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, { "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] + }, + { + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\n\nWebhook events for GitHub Discussions are currently in public preview and subject to change.
\nA secret scanning alert dismissal request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -52478,643 +52798,335 @@ "description": "", "isRequired": true, "enum": [ - "edited" + "created" ], "childParamsGroups": [] }, { "type": "object", - "name": "changes", + "name": "enterprise", "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "from", - "description": "", - "isRequired": true - } - ] - } - ] + "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.\"
A Discussion in a repository.
", + "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 request from a user to be exempted from a set of rules.
", "isRequired": true, "childParamsGroups": [ - { - "type": "string or null", - "name": "active_lock_reason", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "answer_chosen_at", - "description": "", - "isRequired": true - }, - { - "type": "object or null", - "name": "answer_chosen_by", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "answer_html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "author_association", - "description": "How the author is associated with the repository.
", - "isRequired": true, - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - { - "type": "string", - "name": "body", - "description": "", - "isRequired": true - }, - { - "type": "object", - "name": "category", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "emoji", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "is_answerable", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "integer", - "name": "repository_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "slug", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true - } - ] - }, { "type": "integer", - "name": "comments", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true + "name": "id", + "description": "The ID of the exemption request.
" }, { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true + "type": "integer or null", + "name": "number", + "description": "The number uniquely identifying the exemption request within it's repository.
" }, { "type": "integer", - "name": "id", - "description": "", - "isRequired": true + "name": "repository_id", + "description": "The ID of the repository the exemption request is for.
" }, { - "type": "boolean", - "name": "locked", - "description": "", - "isRequired": true + "type": "integer", + "name": "requester_id", + "description": "The ID of the user who requested the exemption.
" }, { "type": "string", - "name": "node_id", - "description": "", - "isRequired": true + "name": "requester_login", + "description": "The login of the user who requested the exemption.
" }, { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true + "type": "string", + "name": "request_type", + "description": "The type of request.
", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] }, { "type": "object", - "name": "reactions", + "name": "exemption_request_data", "description": "", "childParamsGroups": [ { - "type": "integer", - "name": "+1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "-1", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "confused", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "eyes", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "heart", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "hooray", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "laugh", - "description": "", - "isRequired": true + "type": "object", + "name": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "push_ruleset_bypass" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the push rules that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "ruleset_id", + "description": "The ID of the ruleset for the rules that were violated
" + }, + { + "type": "string", + "name": "ruleset_name", + "description": "The name of the ruleset for the rules that were violated
" + }, + { + "type": "integer", + "name": "total_violations", + "description": "The number of violations
" + }, + { + "type": "string", + "name": "rule_type", + "description": "The type of rule that was violated
" + } + ] + } + ] }, { - "type": "integer", - "name": "rocket", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.
", + "childParamsGroups": [ + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "array of objects", + "name": "locations", + "description": "The location data of the secret that was detected
", + "childParamsGroups": [ + { + "type": "string", + "name": "commit", + "description": "The commit SHA where the secret was detected
" + }, + { + "type": "string", + "name": "branch", + "description": "The branch where the secret was detected
" + }, + { + "type": "string", + "name": "path", + "description": "The path of the file where the secret was detected
" + } + ] + } + ] + } + ] }, { - "type": "integer", - "name": "total_count", - "description": "", - "isRequired": true + "type": "object", + "name": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "secret_scanning_closure" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the secret scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "reason", + "description": "The reason for the dismissal request
", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that was detected
" + }, + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert that was detected
" + } + ] + } + ] }, { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "object", + "name": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "The type of request
", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + { + "type": "array of objects", + "name": "data", + "description": "The data related to the code scanning alerts that have dismissal requests.
", + "childParamsGroups": [ + { + "type": "string", + "name": "alert_number", + "description": "The number of the alert to be dismissed
" + } + ] + } + ] } - ] + ], + "oneOfObject": true }, { "type": "string", - "name": "repository_url", - "description": "", - "isRequired": true + "name": "resource_identifier", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.
" }, { "type": "string", - "name": "state", - "description": "The current state of the discussion.\nconverting means that the discussion is being converted from an issue.\ntransferring means that the discussion is being transferred from another repository.
The status of the exemption request.
", "enum": [ - "open", - "closed", - "locked", - "converting", - "transferring" + "pending", + "rejected", + "cancelled", + "completed" ] }, { "type": "string or null", - "name": "state_reason", - "description": "The reason for the current state
", - "isRequired": true, - "enum": [ - "resolved", - "outdated", - "duplicate", - "reopened", - null - ] + "name": "requester_comment", + "description": "The comment the requester provided when creating the exemption request.
" }, { - "type": "string", - "name": "timeline_url", - "description": "" + "type": "object or null", + "name": "metadata", + "description": "Metadata about the exemption request.
" }, { "type": "string", - "name": "title", - "description": "", - "isRequired": true + "name": "expires_at", + "description": "The date and time the exemption request will expire.
" }, { "type": "string", - "name": "updated_at", - "description": "", - "isRequired": true + "name": "created_at", + "description": "The date and time the exemption request was created.
" }, { - "type": "object or null", - "name": "user", - "description": "", - "isRequired": true, + "type": "array of objects or null", + "name": "responses", + "description": "The responses to the exemption request.
", "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, { "type": "integer", "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" + "description": "The ID of the exemption response.
" }, { - "type": "string", - "name": "starred_url", - "description": "" + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "subscriptions_url", - "description": "" + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" }, { "type": "string", - "name": "type", - "description": "", + "name": "status", + "description": "The status of the exemption response.
", "enum": [ - "Bot", - "User", - "Organization" + "approved", + "rejected", + "dismissed" ] }, { - "type": "string", - "name": "url", - "description": "" + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" }, { "type": "string", - "name": "user_view_type", - "description": "" + "name": "created_at", + "description": "The date and time the exemption request was created.
" } ] }, { - "type": "array of objects", - "name": "labels", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "id", - "description": "Unique identifier for 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": "name", - "description": "The name of the label.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "description", - "description": "Optional description of the label, such as its purpose.
", - "isRequired": true - }, - { - "type": "string", - "name": "color", - "description": "6-character hex code, without the leading #, identifying the color
", - "isRequired": true - }, - { - "type": "boolean", - "name": "default", - "description": "Whether this label comes by default in a new repository.
", - "isRequired": true - } - ] + "type": "string", + "name": "html_url", + "description": "The URL to view the exemption request in a browser.
" } ] }, - { - "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.\"
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 code scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "action": "created", + "category": "dismissal_request_secret_scanning" + }, + "response_dismissed": { + "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -53145,7 +53155,7 @@ "description": "", "isRequired": true, "enum": [ - "created" + "response_dismissed" ], "childParamsGroups": [] }, @@ -53474,6 +53484,50 @@ } ] }, + { + "type": "object", + "name": "exemption_response", + "in": "body", + "description": "A response to an exemption request by a delegated bypasser.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "The ID of the exemption response.
" + }, + { + "type": "integer", + "name": "reviewer_id", + "description": "The ID of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "reviewer_login", + "description": "The login of the user who reviewed the exemption request.
" + }, + { + "type": "string", + "name": "status", + "description": "The status of the exemption response.
", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + { + "type": "string or null", + "name": "reviewer_comment", + "description": "The comment the reviewer provided when responding to the exemption request.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The date and time the exemption request was created.
" + } + ] + }, { "type": "object", "name": "sender", @@ -53488,12 +53542,12 @@ "organization", "app" ], - "action": "created", - "category": "dismissal_request_code_scanning" + "action": "response_dismissed", + "category": "dismissal_request_secret_scanning" }, "response_submitted": { - "descriptionHtml": "A code scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.
", + "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", "bodyParameters": [ { "type": "string", @@ -53890,13 +53944,73 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_code_scanning" + "category": "dismissal_request_secret_scanning" } }, - "dismissal_request_secret_scanning": { + "enterprise": { + "anonymous_access_disabled": { + "descriptionHtml": "Anonymous Git read access was disabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_disabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_disabled", + "category": "enterprise" + }, + "anonymous_access_enabled": { + "descriptionHtml": "Anonymous Git read access was enabled.
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "anonymous_access_enabled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "business" + ], + "action": "anonymous_access_enabled", + "category": "enterprise" + } + }, + "exemption_request_push_ruleset": { "cancelled": { - "descriptionHtml": "A secret scanning alert dismissal request was canceled.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was cancelled.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54249,11 +54363,11 @@ "app" ], "action": "cancelled", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "completed": { - "descriptionHtml": "A secret scanning alert dismissal request was completed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was completed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54606,11 +54720,11 @@ "app" ], "action": "completed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "created": { - "descriptionHtml": "A secret scanning alert dismissal request was created.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass request was created.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54963,11 +55077,11 @@ "app" ], "action": "created", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_dismissed": { - "descriptionHtml": "A secret scanning alert dismissal response was dismissed.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A push ruleset bypass response was dismissed.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55364,11 +55478,11 @@ "app" ], "action": "response_dismissed", - "category": "dismissal_request_secret_scanning" + "category": "exemption_request_push_ruleset" }, "response_submitted": { - "descriptionHtml": "A secret scanning alert dismissal response was submitted.
", - "summaryHtml": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.
", + "descriptionHtml": "A response either approving or rejecting the push ruleset bypass request was submitted.
", + "summaryHtml": "This event occurs when there is activity related to a user's request to bypass a set of push rules.
\nFor more information, see \"Managing requests to bypass push rulesets.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55765,67 +55879,7 @@ "app" ], "action": "response_submitted", - "category": "dismissal_request_secret_scanning" - } - }, - "enterprise": { - "anonymous_access_disabled": { - "descriptionHtml": "Anonymous Git read access was disabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_disabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_disabled", - "category": "enterprise" - }, - "anonymous_access_enabled": { - "descriptionHtml": "Anonymous Git read access was enabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "anonymous_access_enabled" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "business" - ], - "action": "anonymous_access_enabled", - "category": "enterprise" + "category": "exemption_request_push_ruleset" } }, "fork": { @@ -207075,6 +207129,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -208215,6 +208311,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -209355,6 +209493,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -210469,6 +210649,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -211395,6 +211617,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } @@ -212326,6 +212590,48 @@ "name": "required_review_thread_resolution", "description": "All conversations on code must be resolved before a pull request can be merged.
", "isRequired": true + }, + { + "type": "array of objects", + "name": "required_reviewers", + "description": "Note
\n\nrequired_reviewers is in beta and subject to change.
A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.
", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "file_patterns", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.
", + "isRequired": true + }, + { + "type": "integer", + "name": "minimum_approvals", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional.
", + "isRequired": true + }, + { + "type": "object", + "name": "reviewer", + "description": "A required reviewing team
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "ID of the reviewer which must review changes to matching files.
", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "The type of the reviewer
", + "isRequired": true, + "enum": [ + "Team" + ] + } + ] + } + ] } ] } diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 8c4d98cec5c8..206512df75c4 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "0fb9cbe3fd548654115fbe4d8beb758228826ae6" + "sha": "567046173a5469ed9d537d9d3ac397f51f1c6c77" } \ No newline at end of file