diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 930f0f29e2..83e2a7ab27 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -4851,15 +4851,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4889,21 +4889,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4939,21 +4942,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -4986,21 +4992,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5033,21 +5042,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5077,21 +5089,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5127,8 +5142,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36200,6 +36218,355 @@ } } }, + "/orgs/{org}/secret-scanning/custom-patterns": { + "get": { + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/secret-scanning/pattern-configurations": { "get": { "summary": "List organization pattern configurations", @@ -72744,6 +73111,367 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -114708,7 +115436,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -134032,6 +134760,241 @@ "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", "nullable": true }, + "secret-scanning-custom-pattern": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "secret-scanning-custom-pattern-to-create": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + }, + "secret-scanning-custom-pattern-validation-error": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + }, + "secret-scanning-custom-pattern-to-delete": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, + "secret-scanning-custom-pattern-to-update": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, "secret-scanning-pattern-override": { "type": "object", "properties": { @@ -313677,6 +314640,147 @@ } ] }, + "secret-scanning-custom-pattern-list": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + }, + "secret-scanning-custom-pattern-bulk-create-request": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-create-response": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-delete-request": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + }, + "secret-scanning-custom-pattern-update-request": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + }, + "secret-scanning-custom-pattern": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -336269,6 +337373,47 @@ "type": "string" } }, + "secret-scanning-custom-pattern-state": { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + "secret-scanning-custom-pattern-push-protection": { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + "secret-scanning-custom-pattern-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -337356,6 +338501,16 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, + "precondition_failed": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "enterprise_team_unsupported": { "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level." }, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 2397d0499c..5d87e53712 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -3696,15 +3696,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3723,19 +3727,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3756,18 +3765,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3788,18 +3803,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3819,18 +3840,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3849,18 +3876,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3881,6 +3914,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -26680,6 +26716,245 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -53279,6 +53554,249 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -83369,7 +83887,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string @@ -98730,6 +99248,183 @@ components: the current version of the entity and mitigate unintentionally overriding someone else's update. nullable: true + secret-scanning-custom-pattern: + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, derived from + its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created in ISO 8601 + format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated in ISO + 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + secret-scanning-custom-pattern-to-create: + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + secret-scanning-custom-pattern-validation-error: + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + secret-scanning-custom-pattern-to-delete: + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + secret-scanning-custom-pattern-to-update: + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable field + (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) + must also be provided. Only provided fields will be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" secret-scanning-pattern-override: type: object properties: @@ -235887,6 +236582,108 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + secret-scanning-custom-pattern-list: + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + secret-scanning-custom-pattern-bulk-create-request: + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + secret-scanning-custom-pattern-bulk-create-response: + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + secret-scanning-custom-pattern-bulk-delete-request: + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern-update-request: + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern: + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -255420,6 +256217,40 @@ components: required: false schema: type: string + secret-scanning-custom-pattern-state: + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + secret-scanning-custom-pattern-push-protection: + name: push_protection + description: Filter custom patterns by whether push protection is enabled. When + absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + secret-scanning-custom-pattern-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -256257,6 +257088,12 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. + precondition_failed: + description: Precondition Failed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" enterprise_team_unsupported: description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index a9a0cd9bae..00e27d7f8b 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -4851,15 +4851,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4889,21 +4889,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4939,21 +4942,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -4986,21 +4992,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5033,21 +5042,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5077,21 +5089,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5127,8 +5142,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36162,6 +36180,355 @@ } } }, + "/orgs/{org}/secret-scanning/custom-patterns": { + "get": { + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/secret-scanning/pattern-configurations": { "get": { "summary": "List organization pattern configurations", @@ -72661,6 +73028,367 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -114559,7 +115287,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -133498,6 +134226,241 @@ "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", "nullable": true }, + "secret-scanning-custom-pattern": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "secret-scanning-custom-pattern-to-create": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + }, + "secret-scanning-custom-pattern-validation-error": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + }, + "secret-scanning-custom-pattern-to-delete": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, + "secret-scanning-custom-pattern-to-update": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, "secret-scanning-pattern-override": { "type": "object", "properties": { @@ -312915,6 +313878,147 @@ } ] }, + "secret-scanning-custom-pattern-list": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + }, + "secret-scanning-custom-pattern-bulk-create-request": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-create-response": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-delete-request": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + }, + "secret-scanning-custom-pattern-update-request": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + }, + "secret-scanning-custom-pattern": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -335409,6 +336513,47 @@ "type": "string" } }, + "secret-scanning-custom-pattern-state": { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + "secret-scanning-custom-pattern-push-protection": { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + "secret-scanning-custom-pattern-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -336496,6 +337641,16 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, + "precondition_failed": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "enterprise_team_unsupported": { "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level." }, diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 8c5c7e5837..d89299c260 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -3696,15 +3696,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3723,19 +3727,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3756,18 +3765,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3788,18 +3803,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3819,18 +3840,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3849,18 +3876,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3881,6 +3914,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -26651,6 +26687,245 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -53207,6 +53482,249 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -83244,7 +83762,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string @@ -98306,6 +98824,183 @@ components: the current version of the entity and mitigate unintentionally overriding someone else's update. nullable: true + secret-scanning-custom-pattern: + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, derived from + its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created in ISO 8601 + format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated in ISO + 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + secret-scanning-custom-pattern-to-create: + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + secret-scanning-custom-pattern-validation-error: + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + secret-scanning-custom-pattern-to-delete: + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + secret-scanning-custom-pattern-to-update: + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable field + (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) + must also be provided. Only provided fields will be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" secret-scanning-pattern-override: type: object properties: @@ -235197,6 +235892,108 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + secret-scanning-custom-pattern-list: + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + secret-scanning-custom-pattern-bulk-create-request: + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + secret-scanning-custom-pattern-bulk-create-response: + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + secret-scanning-custom-pattern-bulk-delete-request: + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern-update-request: + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern: + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -254638,6 +255435,40 @@ components: required: false schema: type: string + secret-scanning-custom-pattern-state: + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + secret-scanning-custom-pattern-push-protection: + name: push_protection + description: Filter custom patterns by whether push protection is enabled. When + absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + secret-scanning-custom-pattern-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -255475,6 +256306,12 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. + precondition_failed: + description: Precondition Failed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" enterprise_team_unsupported: description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 7e98864f30..607c0a8b76 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -4865,15 +4865,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -4903,21 +4903,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -4953,21 +4956,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -5000,21 +5006,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -5047,21 +5056,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -5091,21 +5103,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -5141,8 +5156,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36392,6 +36410,355 @@ } } }, + "/orgs/{org}/secret-scanning/custom-patterns": { + "get": { + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/secret-scanning/pattern-configurations": { "get": { "summary": "List organization pattern configurations", @@ -73051,6 +73418,367 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + }, + { + "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-custom-pattern" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "412": { + "$ref": "#/components/responses/precondition_failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -115191,7 +115919,7 @@ "app-permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -135020,6 +135748,241 @@ "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", "nullable": true }, + "secret-scanning-custom-pattern": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "secret-scanning-custom-pattern-to-create": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + }, + "secret-scanning-custom-pattern-validation-error": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + }, + "secret-scanning-custom-pattern-to-delete": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, + "secret-scanning-custom-pattern-to-update": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + } + } + }, "secret-scanning-pattern-override": { "type": "object", "properties": { @@ -315854,6 +316817,147 @@ } ] }, + "secret-scanning-custom-pattern-list": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + }, + "secret-scanning-custom-pattern-bulk-create-request": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-create-response": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + }, + "secret-scanning-custom-pattern-bulk-delete-request": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + }, + "secret-scanning-custom-pattern-update-request": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + }, + "secret-scanning-custom-pattern": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + }, "secret-scanning-pattern-configuration": { "value": { "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", @@ -338610,6 +339714,47 @@ "type": "string" } }, + "secret-scanning-custom-pattern-state": { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + "secret-scanning-custom-pattern-push-protection": { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + "secret-scanning-custom-pattern-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, "network-configuration-id": { "name": "network_configuration_id", "description": "Unique identifier of the hosted compute network configuration.", @@ -339697,6 +340842,16 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, + "precondition_failed": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "enterprise_team_unsupported": { "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level." }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index dbf873b6e2..a796379333 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -3704,15 +3704,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3731,19 +3735,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - "$ref": "#/components/parameters/assignment-id" - "$ref": "#/components/parameters/page" @@ -3764,18 +3773,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - "$ref": "#/components/parameters/assignment-id" responses: @@ -3796,18 +3811,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per-page" @@ -3827,18 +3848,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" responses: @@ -3857,18 +3884,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - "$ref": "#/components/parameters/classroom-id" - "$ref": "#/components/parameters/page" @@ -3889,6 +3922,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -26782,6 +26818,245 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/org" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -53467,6 +53742,249 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-state" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-push-protection" + - "$ref": "#/components/parameters/secret-scanning-custom-pattern-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-list" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-create" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-request" + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-create-response" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-validation-error" + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-delete" + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-bulk-delete-request" + responses: + '204': + description: All patterns deleted successfully. + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern-to-update" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern-update-request" + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-custom-pattern" + examples: + default: + "$ref": "#/components/examples/secret-scanning-custom-pattern" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '412': + "$ref": "#/components/responses/precondition_failed" + '422': + "$ref": "#/components/responses/validation_failed" "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -83659,7 +84177,7 @@ components: app-permissions: title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access token. properties: actions: type: string @@ -99410,6 +99928,183 @@ components: the current version of the entity and mitigate unintentionally overriding someone else's update. nullable: true + secret-scanning-custom-pattern: + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, derived from + its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created in ISO 8601 + format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated in ISO + 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + secret-scanning-custom-pattern-to-create: + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + secret-scanning-custom-pattern-validation-error: + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + secret-scanning-custom-pattern-to-delete: + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + secret-scanning-custom-pattern-to-update: + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable field + (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) + must also be provided. Only provided fields will be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" secret-scanning-pattern-override: type: object properties: @@ -237310,6 +238005,108 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + secret-scanning-custom-pattern-list: + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + secret-scanning-custom-pattern-bulk-create-request: + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + secret-scanning-custom-pattern-bulk-create-response: + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + secret-scanning-custom-pattern-bulk-delete-request: + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern-update-request: + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + secret-scanning-custom-pattern: + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' secret-scanning-pattern-configuration: value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K @@ -256925,6 +257722,40 @@ components: required: false schema: type: string + secret-scanning-custom-pattern-state: + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + secret-scanning-custom-pattern-push-protection: + name: push_protection + description: Filter custom patterns by whether push protection is enabled. When + absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + secret-scanning-custom-pattern-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -257762,6 +258593,12 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. + precondition_failed: + description: Precondition Failed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" enterprise_team_unsupported: description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 208209c870..a900d2b933 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -7888,7 +7888,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -8890,7 +8890,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9746,7 +9746,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10233,7 +10233,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12290,7 +12290,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13343,7 +13343,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14313,7 +14313,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14994,7 +14994,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16314,15 +16314,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16651,21 +16651,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -17034,21 +17037,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17197,21 +17203,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17291,21 +17300,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17449,21 +17461,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17689,8 +17704,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -148201,7 +148219,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -149218,7 +149236,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -223507,23 +223525,23 @@ } } }, - "/orgs/{org}/secret-scanning/pattern-configurations": { + "/orgs/{org}/secret-scanning/custom-patterns": { "get": { - "summary": "List organization pattern configurations", - "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "secret-scanning" ], - "operationId": "secret-scanning/list-org-pattern-configs", + "operationId": "secret-scanning/list-org-custom-patterns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "secret-scanning", - "subcategory": "push-protection" + "subcategory": "custom-patterns" }, "parameters": [ { @@ -223534,6 +223552,79 @@ "schema": { "type": "string" } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -223542,198 +223633,1534 @@ "content": { "application/json": { "schema": { - "title": "Secret scanning pattern configuration", - "description": "A collection of secret scanning patterns and their settings related to push protection.", - "type": "object", - "properties": { - "pattern_config_version": { - "type": "string", - "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", - "nullable": true - }, - "provider_pattern_overrides": { - "type": "array", - "description": "Overrides for partner patterns.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" } - } - }, - "custom_pattern_overrides": { - "type": "array", - "description": "Overrides for custom patterns defined by the organization.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." } - } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] } }, "examples": { "default": { - "value": { - "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "provider_pattern_overrides": [ - { - "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", - "slug": "github_personal_access_token_legacy_v2", - "display_name": "GitHub Personal Access Token (Legacy v2)", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 2, - "false_positive_rate": 13, - "bypass_rate": 13, - "default_setting": "enabled", - "setting": "enabled", - "enterprise_setting": "enabled" - } - ], - "custom_pattern_overrides": [ - { - "token_type": "cp_2", - "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "slug": "custom-api-key", - "display_name": "Custom API Key", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 3, - "false_positive_rate": 20, - "bypass_rate": 20, - "default_setting": "disabled", - "setting": "enabled" - } - ] - } + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } } } } @@ -384821,7 +386248,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -576642,6 +578069,1451 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -641332,7 +644204,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -721485,7 +724357,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -914874,7 +917746,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -917497,7 +920369,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -920027,7 +922899,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -922557,7 +925429,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -925219,7 +928091,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -927888,7 +930760,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -932194,7 +935066,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 129071cbeb..dd20e07aee 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -864,7 +864,7 @@ paths: - subscriptions_url - type - url - type: &345 + type: &347 type: string description: The type of credit the user is receiving. enum: @@ -1030,7 +1030,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &699 + - &714 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -4736,7 +4736,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6697,15 +6698,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -6954,19 +6959,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7218,18 +7228,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7319,18 +7335,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7353,18 +7375,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - &35 name: classroom_id @@ -7398,18 +7426,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - *35 - *19 @@ -7451,6 +7485,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -12008,7 +12045,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &508 + - &510 name: has in: query description: |- @@ -12134,7 +12171,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &509 + security_advisory: &511 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12403,14 +12440,14 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &510 + auto_dismissed_at: &512 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &511 + dismissal_request: &513 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -14098,7 +14135,7 @@ paths: properties: action: type: string - discussion: &795 + discussion: &810 title: Discussion description: A Discussion in a repository. type: object @@ -14465,7 +14502,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &563 + properties: &565 id: type: integer format: int64 @@ -14843,7 +14880,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &710 + sub_issues_summary: &725 title: Sub-issues Summary type: object properties: @@ -14930,7 +14967,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &589 + properties: &591 pinned_at: type: string format: date-time @@ -14942,7 +14979,7 @@ paths: properties: *20 required: *21 nullable: true - required: &590 + required: &592 - pinned_at - pinned_by nullable: true @@ -14951,13 +14988,13 @@ paths: description: Details about why an issue comment was minimized. type: object - properties: &591 + properties: &593 reason: description: The reason the comment was minimized. type: string nullable: true example: low-quality - required: &592 + required: &594 - reason nullable: true required: &90 @@ -14970,7 +15007,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &711 + issue_dependencies_summary: &726 title: Issue Dependencies Summary type: object properties: @@ -14989,7 +15026,7 @@ paths: - total_blocking issue_field_values: type: array - items: &573 + items: &575 title: Issue Field Value description: A value assigned to an issue field type: object @@ -15081,7 +15118,7 @@ paths: - node_id - data_type - value - required: &564 + required: &566 - assignee - closed_at - comments @@ -15119,7 +15156,7 @@ paths: action: type: string issue: *88 - comment: &559 + comment: &561 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15783,7 +15820,7 @@ paths: type: string release: allOf: - - &636 + - &638 title: Release description: A release. type: object @@ -15854,7 +15891,7 @@ paths: author: *4 assets: type: array - items: &637 + items: &639 title: Release Asset description: Data related to a release. type: object @@ -16445,7 +16482,7 @@ paths: url: type: string format: uri - user: &719 + user: &734 title: Public User description: Public User type: object @@ -19758,14 +19795,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &354 + - &356 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &355 + - &357 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19827,7 +19864,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &358 + '301': &360 description: Moved permanently content: application/json: @@ -19849,7 +19886,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &612 + - &614 name: all description: If `true`, show notifications marked as read. in: query @@ -19857,7 +19894,7 @@ paths: schema: type: boolean default: false - - &613 + - &615 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19867,7 +19904,7 @@ paths: type: boolean default: false - *95 - - &614 + - &616 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -20397,7 +20434,7 @@ paths: - url - subscription_url examples: - default: &615 + default: &617 value: - id: '1' repository: @@ -22311,7 +22348,7 @@ paths: parameters: - *78 - *124 - - &771 + - &786 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -22423,7 +22460,7 @@ paths: - *124 - *125 - *126 - - &772 + - &787 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22431,7 +22468,7 @@ paths: schema: type: string - *129 - - &773 + - &788 name: sku description: The SKU to query for usage. in: query @@ -23333,7 +23370,7 @@ paths: type: integer repository_cache_usages: type: array - items: &365 + items: &367 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -24675,7 +24712,7 @@ paths: - all - local_only - selected - selected_actions_url: &370 + selected_actions_url: &372 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -24758,7 +24795,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &376 type: object properties: days: @@ -24800,7 +24837,7 @@ paths: required: true content: application/json: - schema: &375 + schema: &377 type: object properties: days: @@ -24857,7 +24894,7 @@ paths: required: - approval_policy examples: - default: &376 + default: &378 value: approval_policy: first_time_contributors '404': *6 @@ -24916,7 +24953,7 @@ paths: description: Response content: application/json: - schema: &377 + schema: &379 type: object required: - run_workflows_from_fork_pull_requests @@ -24970,7 +25007,7 @@ paths: required: true content: application/json: - schema: &378 + schema: &380 type: object required: - run_workflows_from_fork_pull_requests @@ -25605,7 +25642,7 @@ paths: description: Response content: application/json: - schema: &379 + schema: &381 type: object properties: default_workflow_permissions: &156 @@ -25656,7 +25693,7 @@ paths: required: false content: application/json: - schema: &380 + schema: &382 type: object properties: default_workflow_permissions: *156 @@ -26796,7 +26833,7 @@ paths: application/json: schema: type: array - items: &381 + items: &383 title: Runner Application description: Runner Application type: object @@ -26821,7 +26858,7 @@ paths: - download_url - filename examples: - default: &382 + default: &384 value: - os: osx architecture: x64 @@ -26907,7 +26944,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &383 + '201': &385 description: Response content: application/json: @@ -27018,7 +27055,7 @@ paths: - token - expires_at examples: - default: &384 + default: &386 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -27057,7 +27094,7 @@ paths: application/json: schema: *167 examples: - default: &385 + default: &387 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -27091,7 +27128,7 @@ paths: application/json: schema: *165 examples: - default: &386 + default: &388 value: id: 23 name: MBP @@ -27318,7 +27355,7 @@ paths: - *78 - *164 responses: - '200': &387 + '200': &389 description: Response content: application/json: @@ -27375,7 +27412,7 @@ paths: parameters: - *78 - *164 - - &388 + - &390 name: name description: The name of a self-hosted runner's custom label. in: path @@ -29944,12 +29981,12 @@ paths: required: - subject_digests examples: - default: &752 + default: &767 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &753 + withPredicateType: &768 value: subject_digests: - sha256:abc123 @@ -30007,7 +30044,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &754 + default: &769 value: attestations_subject_digests: - sha256:abc: @@ -30357,7 +30394,7 @@ paths: initiator: type: string examples: - default: &414 + default: &416 value: attestations: - bundle: @@ -31297,7 +31334,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *78 - - &441 + - &443 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -31307,7 +31344,7 @@ paths: schema: &195 type: string description: The name of the tool used to generate the code scanning analysis. - - &442 + - &444 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -31330,7 +31367,7 @@ paths: be returned. in: query required: false - schema: &444 + schema: &446 type: string description: State of a code scanning alert. enum: @@ -31353,7 +31390,7 @@ paths: be returned. in: query required: false - schema: &445 + schema: &447 type: string description: Severity of a code scanning alert. enum: @@ -31387,7 +31424,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: &446 + instances_url: &448 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -31410,7 +31447,7 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: &447 + dismissed_reason: &449 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -31419,13 +31456,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &448 + dismissed_comment: &450 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &449 + rule: &451 type: object properties: id: @@ -31478,7 +31515,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &450 + tool: &452 type: object properties: name: *195 @@ -31488,26 +31525,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *196 - most_recent_instance: &451 + most_recent_instance: &453 type: object properties: - ref: &443 + ref: &445 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &461 + analysis_key: &463 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &462 + environment: &464 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &463 + category: &465 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -31527,7 +31564,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &464 + location: &466 type: object description: Describe a region within a file for the alert. properties: @@ -31548,7 +31585,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &465 + items: &467 type: string description: A classification of the file. For example to identify it as generated. @@ -32879,7 +32916,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &477 + properties: &479 name: type: string description: The name of the machine. @@ -32921,7 +32958,7 @@ paths: - ready - in_progress nullable: true - required: &478 + required: &480 - name - display_name - operating_system @@ -33789,7 +33826,7 @@ paths: - updated_at - visibility examples: - default: &479 + default: &481 value: total_count: 2 secrets: @@ -33827,7 +33864,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &482 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -33856,7 +33893,7 @@ paths: - key_id - key examples: - default: &481 + default: &483 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33888,7 +33925,7 @@ paths: application/json: schema: *203 examples: - default: &483 + default: &485 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -37425,7 +37462,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &516 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -37442,7 +37479,7 @@ paths: - key_id - key examples: - default: &515 + default: &517 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39240,7 +39277,7 @@ paths: application/json: schema: *22 examples: - default: &552 + default: &554 value: id: 1 account: @@ -39465,7 +39502,7 @@ paths: required: true content: application/json: - schema: &553 + schema: &555 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -40271,7 +40308,7 @@ paths: type: array items: *257 examples: - default: &557 + default: &559 value: - id: 410 node_id: IT_kwDNAd3NAZo @@ -40794,7 +40831,7 @@ paths: application/json: schema: *262 examples: - default: &476 + default: &478 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -42043,7 +42080,7 @@ paths: parameters: - *78 - *269 - - &735 + - &750 name: repo_name description: repo_name parameter in: path @@ -42790,7 +42827,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &346 + items: &348 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -43084,7 +43121,7 @@ paths: - nuget - container - *78 - - &736 + - &751 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43125,7 +43162,7 @@ paths: default: *276 '403': *29 '401': *25 - '400': &738 + '400': &753 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45222,7 +45259,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &826 + properties: &841 id: type: number description: The unique identifier of the status update. @@ -45270,7 +45307,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &827 + required: &842 - id - node_id - created_at @@ -45484,7 +45521,7 @@ paths: content: oneOf: - *88 - - &493 + - &495 title: Pull Request Simple description: Pull Request Simple type: object @@ -45710,7 +45747,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: &622 + auto_merge: &624 title: Auto merge description: The status of auto merging a pull request. type: object @@ -46088,7 +46125,7 @@ paths: - updated_at - project_url examples: - default: &758 + default: &773 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46265,7 +46302,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &759 + items: &774 type: object properties: name: @@ -46302,7 +46339,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &760 + iteration_configuration: &775 type: object description: The configuration for iteration fields. properties: @@ -46352,7 +46389,7 @@ paths: value: name: Due date data_type: date - single_select_field: &761 + single_select_field: &776 summary: Create a single select field value: name: Priority @@ -46379,7 +46416,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &762 + iteration_field: &777 summary: Create an iteration field value: name: Sprint @@ -46405,7 +46442,7 @@ paths: application/json: schema: *297 examples: - text_field: &763 + text_field: &778 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46414,7 +46451,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &764 + number_field: &779 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46423,7 +46460,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &765 + date_field: &780 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46432,7 +46469,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &766 + single_select_field: &781 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46466,7 +46503,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &767 + iteration_field: &782 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46512,7 +46549,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *293 - - &768 + - &783 name: field_id description: The unique identifier of the field. in: path @@ -46527,7 +46564,7 @@ paths: application/json: schema: *297 examples: - default: &769 + default: &784 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47724,7 +47761,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &749 + schema: &764 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -47901,7 +47938,7 @@ paths: parameters: - *293 - *78 - - &770 + - &785 name: view_number description: The number that identifies the project view. in: path @@ -48838,7 +48875,7 @@ paths: description: Response content: application/json: - schema: &357 + schema: &359 title: Full Repository description: Full Repository type: object @@ -49242,7 +49279,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &498 + properties: &500 url: type: string format: uri @@ -49258,7 +49295,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &499 + required: &501 - url - key - name @@ -49347,7 +49384,7 @@ paths: - network_count - subscribers_count examples: - default: &359 + default: &361 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49868,7 +49905,7 @@ paths: - *78 - *17 - *19 - - &645 + - &647 name: targets description: | A comma-separated list of rule targets to filter by. @@ -50150,7 +50187,7 @@ paths: - repository_property rules: type: array - items: &646 + items: &648 title: Repository Rule type: object description: A repository rule. @@ -50212,7 +50249,7 @@ paths: type: string enum: - required_linear_history - - &643 + - &645 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -50851,7 +50888,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &644 + - &646 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -51163,7 +51200,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *78 - - &647 + - &649 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -51178,7 +51215,7 @@ paths: in: query schema: type: string - - &648 + - &650 name: time_period description: |- The time period to filter by. @@ -51194,14 +51231,14 @@ paths: - week - month default: day - - &649 + - &651 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &650 + - &652 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51214,7 +51251,7 @@ paths: - bypass - all default: all - - &651 + - &653 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -51237,7 +51274,7 @@ paths: description: Response content: application/json: - schema: &652 + schema: &654 title: Rule Suites description: Response type: array @@ -51292,7 +51329,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &653 + default: &655 value: - id: 21 actor_id: 12 @@ -51336,7 +51373,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *78 - - &654 + - &656 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51352,7 +51389,7 @@ paths: description: Response content: application/json: - schema: &655 + schema: &657 title: Rule Suite description: Response type: object @@ -51451,7 +51488,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &656 + default: &658 value: id: 21 actor_id: 12 @@ -51698,7 +51735,7 @@ paths: type: string format: date-time examples: - default: &658 + default: &660 value: - version_id: 3 actor: @@ -51751,7 +51788,7 @@ paths: description: Response content: application/json: - schema: &659 + schema: &661 allOf: - *342 - type: object @@ -51823,7 +51860,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *78 - - &660 + - &662 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -51834,7 +51871,7 @@ paths: enum: - open - resolved - - &661 + - &663 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -51844,7 +51881,7 @@ paths: required: false schema: type: string - - &662 + - &664 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -51855,7 +51892,7 @@ paths: required: false schema: type: string - - &663 + - &665 name: exclude_providers in: query description: |- @@ -51866,7 +51903,7 @@ paths: required: false schema: type: string - - &664 + - &666 name: providers in: query description: |- @@ -51877,7 +51914,7 @@ paths: required: false schema: type: string - - &665 + - &667 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -51886,7 +51923,7 @@ paths: required: false schema: type: string - - &666 + - &668 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -51905,7 +51942,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &667 + - &669 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -51920,7 +51957,7 @@ paths: - *62 - *19 - *17 - - &668 + - &670 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -51930,7 +51967,7 @@ paths: required: false schema: type: string - - &669 + - &671 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -51940,7 +51977,7 @@ paths: required: false schema: type: string - - &670 + - &672 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -51949,7 +51986,7 @@ paths: required: false schema: type: string - - &671 + - &673 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -51958,7 +51995,7 @@ paths: schema: type: boolean default: false - - &672 + - &674 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -51967,7 +52004,7 @@ paths: schema: type: boolean default: false - - &673 + - &675 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -51976,7 +52013,7 @@ paths: schema: type: boolean default: false - - &674 + - &676 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -51987,7 +52024,7 @@ paths: required: false schema: type: boolean - - &675 + - &677 name: included_metadata in: query description: |- @@ -51998,7 +52035,7 @@ paths: required: false schema: type: string - - &676 + - &678 name: owner_email_hash in: query description: |- @@ -52036,14 +52073,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &677 + state: &679 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &678 + resolution: &680 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52160,8 +52197,8 @@ paths: pull request. ' - oneOf: &679 - - &681 + oneOf: &681 + - &683 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52219,7 +52256,7 @@ paths: - blob_url - commit_sha - commit_url - - &682 + - &684 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -52274,7 +52311,7 @@ paths: - page_url - commit_sha - commit_url - - &683 + - &685 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52294,7 +52331,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &684 + - &686 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52314,7 +52351,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &685 + - &687 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52334,7 +52371,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &686 + - &688 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52348,7 +52385,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &687 + - &689 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52362,7 +52399,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &688 + - &690 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52376,7 +52413,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &689 + - &691 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -52396,7 +52433,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &690 + - &692 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -52416,7 +52453,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &691 + - &693 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -52436,7 +52473,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &692 + - &694 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -52456,7 +52493,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &693 + - &695 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -52688,6 +52725,526 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - &696 + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - &697 + name: push_protection + description: Filter custom patterns by whether push protection is enabled. + When absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - &698 + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &343 + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, + derived from its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom + pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: &344 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created + in ISO 8601 format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated + in ISO 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + examples: + default: &699 + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: &700 + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + examples: + default: &701 + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *343 + examples: + default: &702 + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: &703 + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in + a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the + error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: &704 + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: *344 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: &705 + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': &345 + description: Precondition Failed + content: + application/json: + schema: *3 + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: &706 + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable + field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, + or `must_not_match`) must also be provided. Only provided fields will + be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: *344 + examples: + default: &707 + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *343 + examples: + default: &708 + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' + '400': *14 + '403': *29 + '404': *6 + '412': *345 + '422': *15 "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -52719,16 +53276,11 @@ paths: related to push protection. type: object properties: - pattern_config_version: &344 - type: string - description: The version of the entity. This is used to confirm - you're updating the current version of the entity and mitigate - unintentionally overriding someone else's update. - nullable: true + pattern_config_version: *344 provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &343 + items: &346 type: object properties: token_type: @@ -52794,7 +53346,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *343 + items: *346 examples: default: value: @@ -52975,7 +53527,7 @@ paths: application/json: schema: type: array - items: &697 + items: &712 description: A repository security advisory. type: object properties: @@ -53195,7 +53747,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 credits_detailed: type: array nullable: true @@ -53205,7 +53757,7 @@ paths: type: object properties: user: *4 - type: *345 + type: *347 state: type: string description: The state of the user's acceptance of the @@ -53266,7 +53818,7 @@ paths: - private_fork additionalProperties: false examples: - default: &698 + default: &713 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -53653,7 +54205,7 @@ paths: application/json: schema: type: array - items: *346 + items: *348 examples: default: value: @@ -54006,7 +54558,7 @@ paths: type: integer network_configurations: type: array - items: &347 + items: &349 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -54152,9 +54704,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: &348 + default: &350 value: id: 123456789ABCDEF name: My network configuration @@ -54183,7 +54735,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - &349 + - &351 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -54195,9 +54747,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *348 + default: *350 headers: Link: *70 x-github: @@ -54219,7 +54771,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - *349 + - *351 requestBody: required: true content: @@ -54272,9 +54824,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *348 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54294,7 +54846,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *78 - - *349 + - *351 responses: '204': description: Response @@ -54507,7 +55059,7 @@ paths: description: Response content: application/json: - schema: &350 + schema: &352 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -54834,7 +55386,7 @@ paths: - repos_count - organization examples: - default: &351 + default: &353 value: id: 1 node_id: MDQ6VGVhbTE= @@ -54911,9 +55463,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 x-github: githubCloudOnly: false @@ -54997,16 +55549,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '201': description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 '422': *15 '403': *29 @@ -55036,7 +55588,7 @@ paths: responses: '204': description: Response - '422': &352 + '422': &354 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -55075,7 +55627,7 @@ paths: default: *252 headers: Link: *70 - '422': *352 + '422': *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55119,7 +55671,7 @@ paths: application/json: schema: type: array - items: &713 + items: &728 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -55238,7 +55790,7 @@ paths: - type - url examples: - default: &714 + default: &729 value: - login: octocat id: 1 @@ -55297,7 +55849,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &355 title: Team Membership description: Team Membership type: object @@ -55324,7 +55876,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &715 + response-if-user-is-a-team-maintainer: &730 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -55387,9 +55939,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: &716 + response-if-users-membership-with-team-is-now-pending: &731 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -55496,14 +56048,14 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &717 + schema: &732 title: Team Repository description: A team's access to a repository. type: object @@ -56074,8 +56626,8 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -56122,8 +56674,8 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -56160,7 +56712,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &718 + response-if-child-teams-exist: &733 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -56313,7 +56865,7 @@ paths: resources: type: object properties: - core: &356 + core: &358 title: Rate Limit type: object properties: @@ -56330,21 +56882,21 @@ paths: - remaining - reset - used - graphql: *356 - search: *356 - code_search: *356 - source_import: *356 - integration_manifest: *356 - actions_runner_registration: *356 - scim: *356 - dependency_snapshots: *356 - dependency_sbom: *356 - code_scanning_autofix: *356 - copilot_usage_records: *356 + graphql: *358 + search: *358 + code_search: *358 + source_import: *358 + integration_manifest: *358 + actions_runner_registration: *358 + scim: *358 + dependency_snapshots: *358 + dependency_sbom: *358 + code_scanning_autofix: *358 + copilot_usage_records: *358 required: - core - search - rate: *356 + rate: *358 required: - rate - resources @@ -56444,14 +56996,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *357 + schema: *359 examples: default-response: summary: Default response @@ -56956,7 +57508,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *358 + '301': *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56974,8 +57526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -57285,10 +57837,10 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 - '307': &360 + default: *361 + '307': &362 description: Temporary Redirect content: application/json: @@ -57317,8 +57869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -57340,7 +57892,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *360 + '307': *362 '404': *6 '409': *54 x-github: @@ -57364,11 +57916,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - - &392 + - &394 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -57391,7 +57943,7 @@ paths: type: integer artifacts: type: array - items: &361 + items: &363 title: Artifact description: An artifact type: object @@ -57469,7 +58021,7 @@ paths: - expires_at - updated_at examples: - default: &393 + default: &395 value: total_count: 2 artifacts: @@ -57530,9 +58082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *354 - - *355 - - &362 + - *356 + - *357 + - &364 name: artifact_id description: The unique identifier of the artifact. in: path @@ -57544,7 +58096,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *363 examples: default: value: @@ -57582,9 +58134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *354 - - *355 - - *362 + - *356 + - *357 + - *364 responses: '204': description: Response @@ -57608,9 +58160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *354 - - *355 - - *362 + - *356 + - *357 + - *364 - name: archive_format in: path required: true @@ -57620,11 +58172,11 @@ paths: '302': description: Response headers: - Location: &517 + Location: &519 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &558 + '410': &560 description: Gone content: application/json: @@ -57649,14 +58201,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &363 + schema: &365 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -57689,13 +58241,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *363 + schema: *365 examples: selected_actions: *42 responses: @@ -57724,14 +58276,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &364 + schema: &366 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -57764,13 +58316,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *364 + schema: *366 examples: selected_actions: *44 responses: @@ -57801,14 +58353,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *365 + schema: *367 examples: default: value: @@ -57834,11 +58386,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - - &366 + - &368 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -57872,7 +58424,7 @@ paths: description: Response content: application/json: - schema: &367 + schema: &369 title: Repository actions caches description: Repository actions caches type: object @@ -57914,7 +58466,7 @@ paths: - total_count - actions_caches examples: - default: &368 + default: &370 value: total_count: 1 actions_caches: @@ -57946,23 +58498,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *354 - - *355 + - *356 + - *357 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *366 + - *368 responses: '200': description: Response content: application/json: - schema: *367 + schema: *369 examples: - default: *368 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57982,8 +58534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *354 - - *355 + - *356 + - *357 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -58012,8 +58564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *48 responses: @@ -58095,8 +58647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: concurrency_group_name description: The name of the concurrency group. in: path @@ -58248,9 +58800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *354 - - *355 - - &369 + - *356 + - *357 + - &371 name: job_id description: The unique identifier of the job. in: path @@ -58262,7 +58814,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &398 title: Job description: Information of a job execution in a workflow run type: object @@ -58569,9 +59121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *354 - - *355 - - *369 + - *356 + - *357 + - *371 responses: '302': description: Response @@ -58599,9 +59151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *354 - - *355 - - *369 + - *356 + - *357 + - *371 requestBody: required: false content: @@ -58651,8 +59203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Status response @@ -58711,8 +59263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -58780,8 +59332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -58799,7 +59351,7 @@ paths: type: integer secrets: type: array - items: &398 + items: &400 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -58819,7 +59371,7 @@ paths: - created_at - updated_at examples: - default: &399 + default: &401 value: total_count: 2 secrets: @@ -58852,8 +59404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -58871,7 +59423,7 @@ paths: type: integer variables: type: array - items: &400 + items: &402 title: Actions Variable type: object properties: @@ -58901,7 +59453,7 @@ paths: - created_at - updated_at examples: - default: &401 + default: &403 value: total_count: 2 variables: @@ -58934,8 +59486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -58944,11 +59496,11 @@ paths: schema: type: object properties: - enabled: &371 + enabled: &373 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *148 - selected_actions_url: *370 + selected_actions_url: *372 sha_pinning_required: *149 required: - enabled @@ -58977,8 +59529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -58989,7 +59541,7 @@ paths: schema: type: object properties: - enabled: *371 + enabled: *373 allowed_actions: *148 sha_pinning_required: *149 required: @@ -59021,14 +59573,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &372 + schema: &374 type: object properties: access_level: @@ -59045,7 +59597,7 @@ paths: required: - access_level examples: - default: &373 + default: &375 value: access_level: organization x-github: @@ -59069,15 +59621,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *372 + schema: *374 examples: - default: *373 + default: *375 responses: '204': description: Response @@ -59101,14 +59653,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *374 + schema: *376 examples: default: value: @@ -59132,8 +59684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Empty response for successful settings update @@ -59143,7 +59695,7 @@ paths: required: true content: application/json: - schema: *375 + schema: *377 examples: default: summary: Set retention days @@ -59167,8 +59719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -59176,7 +59728,7 @@ paths: application/json: schema: *150 examples: - default: *376 + default: *378 '404': *6 x-github: enabledForGitHubApps: true @@ -59195,8 +59747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -59230,14 +59782,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *377 + schema: *379 examples: default: *151 '403': *29 @@ -59259,13 +59811,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *378 + schema: *380 examples: default: *151 responses: @@ -59291,8 +59843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -59319,8 +59871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -59352,14 +59904,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: default: *158 x-github: @@ -59382,8 +59934,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Success response @@ -59394,7 +59946,7 @@ paths: required: true content: application/json: - schema: *380 + schema: *382 examples: default: *158 x-github: @@ -59423,8 +59975,8 @@ paths: in: query schema: type: string - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -59468,8 +60020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -59477,9 +60029,9 @@ paths: application/json: schema: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59501,8 +60053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -59545,7 +60097,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *383 + '201': *385 '404': *6 '422': *7 '409': *54 @@ -59576,8 +60128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -59585,7 +60137,7 @@ paths: application/json: schema: *167 examples: - default: *384 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59613,8 +60165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -59622,7 +60174,7 @@ paths: application/json: schema: *167 examples: - default: *385 + default: *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59644,8 +60196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '200': @@ -59654,7 +60206,7 @@ paths: application/json: schema: *165 examples: - default: *386 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59675,8 +60227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '204': @@ -59703,8 +60255,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '200': *169 @@ -59729,8 +60281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 requestBody: required: true @@ -59779,8 +60331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 requestBody: required: true @@ -59830,11 +60382,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: - '200': *387 + '200': *389 '404': *6 x-github: githubCloudOnly: false @@ -59861,10 +60413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 - - *388 + - *390 responses: '200': *169 '404': *6 @@ -59892,9 +60444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *354 - - *355 - - &404 + - *356 + - *357 + - &406 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -59902,7 +60454,7 @@ paths: required: false schema: type: string - - &405 + - &407 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -59910,7 +60462,7 @@ paths: required: false schema: type: string - - &406 + - &408 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -59919,7 +60471,7 @@ paths: required: false schema: type: string - - &407 + - &409 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -59946,7 +60498,7 @@ paths: - pending - *17 - *19 - - &408 + - &410 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -59955,7 +60507,7 @@ paths: schema: type: string format: date-time - - &389 + - &391 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -59964,13 +60516,13 @@ paths: schema: type: boolean default: false - - &409 + - &411 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &410 + - &412 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -59993,7 +60545,7 @@ paths: type: integer workflow_runs: type: array - items: &390 + items: &392 title: Workflow Run description: An invocation of a workflow type: object @@ -60141,7 +60693,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &434 + properties: &436 id: type: string description: SHA for the commit @@ -60192,7 +60744,7 @@ paths: - name - email nullable: true - required: &435 + required: &437 - id - tree_id - message @@ -60239,7 +60791,7 @@ paths: - workflow_url - pull_requests examples: - default: &411 + default: &413 value: total_count: 1 workflow_runs: @@ -60475,24 +61027,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *354 - - *355 - - &391 + - *356 + - *357 + - &393 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *389 + - *391 responses: '200': description: Response content: application/json: - schema: *390 + schema: *392 examples: - default: &394 + default: &396 value: id: 30433642 name: Build @@ -60733,9 +61285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '204': description: Response @@ -60758,9 +61310,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -60879,9 +61431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '201': description: Response @@ -60914,12 +61466,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - *17 - *19 - - *392 + - *394 - *62 responses: '200': @@ -60936,9 +61488,9 @@ paths: type: integer artifacts: type: array - items: *361 + items: *363 examples: - default: *393 + default: *395 headers: Link: *70 x-github: @@ -60962,25 +61514,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *354 - - *355 - - *391 - - &395 + - *356 + - *357 + - *393 + - &397 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *389 + - *391 responses: '200': description: Response content: application/json: - schema: *390 + schema: *392 examples: - default: *394 + default: *396 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61003,10 +61555,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *354 - - *355 - - *391 - - *395 + - *356 + - *357 + - *393 + - *397 - *17 - *19 responses: @@ -61024,9 +61576,9 @@ paths: type: integer jobs: type: array - items: *396 + items: *398 examples: - default: &397 + default: &399 value: total_count: 1 jobs: @@ -61139,10 +61691,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *354 - - *355 - - *391 - - *395 + - *356 + - *357 + - *393 + - *397 responses: '302': description: Response @@ -61170,9 +61722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '202': description: Response @@ -61218,9 +61770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - *17 - *47 - *48 @@ -61391,9 +61943,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: true content: @@ -61460,9 +62012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '202': description: Response @@ -61495,9 +62047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -61527,9 +62079,9 @@ paths: type: integer jobs: type: array - items: *396 + items: *398 examples: - default: *397 + default: *399 headers: Link: *70 x-github: @@ -61554,9 +62106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '302': description: Response @@ -61583,9 +62135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '204': description: Response @@ -61612,9 +62164,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -61674,7 +62226,7 @@ paths: items: type: object properties: - type: &524 + type: &526 type: string description: The type of reviewer. enum: @@ -61759,9 +62311,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: true content: @@ -61808,12 +62360,12 @@ paths: application/json: schema: type: array - items: &519 + items: &521 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &789 + properties: &804 url: type: string format: uri @@ -61898,7 +62450,7 @@ paths: nullable: true properties: *83 required: *84 - required: &790 + required: &805 - id - node_id - sha @@ -61914,7 +62466,7 @@ paths: - created_at - updated_at examples: - default: &520 + default: &522 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -61970,9 +62522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: false content: @@ -62016,9 +62568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: false content: @@ -62071,9 +62623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -62210,8 +62762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -62229,9 +62781,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -62256,8 +62808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -62287,17 +62839,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: &412 + default: &414 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -62323,8 +62875,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -62382,8 +62934,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -62409,8 +62961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -62428,9 +62980,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -62453,8 +63005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -62506,17 +63058,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: &413 + default: &415 value: name: USERNAME value: octocat @@ -62542,8 +63094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 requestBody: required: true @@ -62586,8 +63138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '204': @@ -62613,8 +63165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -62632,7 +63184,7 @@ paths: type: integer workflows: type: array - items: &402 + items: &404 title: Workflow description: A GitHub Actions workflow type: object @@ -62739,9 +63291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *354 - - *355 - - &403 + - *356 + - *357 + - &405 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -62756,7 +63308,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *404 examples: default: value: @@ -62789,9 +63341,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '204': description: Response @@ -62816,9 +63368,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -62905,9 +63457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '204': description: Response @@ -62934,19 +63486,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *354 - - *355 - - *403 - - *404 + - *356 + - *357 - *405 - *406 - *407 - - *17 - - *19 - *408 - - *389 - *409 + - *17 + - *19 - *410 + - *391 + - *411 + - *412 responses: '200': description: Response @@ -62962,9 +63514,9 @@ paths: type: integer workflow_runs: type: array - items: *390 + items: *392 examples: - default: *411 + default: *413 headers: Link: *70 x-github: @@ -62996,9 +63548,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '200': description: Response @@ -63059,8 +63611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *354 - - *355 + - *356 + - *357 - *62 - *17 - *47 @@ -63229,8 +63781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-organization-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -63248,9 +63800,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -63274,8 +63826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-organization-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -63293,9 +63845,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -63320,8 +63872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -63339,9 +63891,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -63366,8 +63918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -63397,17 +63949,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63429,8 +63981,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -63488,8 +64040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -63515,8 +64067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -63534,9 +64086,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -63559,8 +64111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#create-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -63612,17 +64164,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#get-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *413 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63643,8 +64195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#update-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 requestBody: required: true @@ -63687,8 +64239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#delete-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '204': @@ -63710,8 +64262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -63748,8 +64300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *354 - - *355 + - *356 + - *357 - name: assignee in: path required: true @@ -63785,8 +64337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -63896,8 +64448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *47 - *48 @@ -63954,7 +64506,7 @@ paths: initiator: type: string examples: - default: *414 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63974,8 +64526,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -63983,7 +64535,7 @@ paths: application/json: schema: type: array - items: &415 + items: &417 title: Autolink reference description: An autolink reference. type: object @@ -64037,8 +64589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -64077,9 +64629,9 @@ paths: description: response content: application/json: - schema: *415 + schema: *417 examples: - default: &416 + default: &418 value: id: 1 key_prefix: TICKET- @@ -64110,9 +64662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *354 - - *355 - - &417 + - *356 + - *357 + - &419 name: autolink_id description: The unique identifier of the autolink. in: path @@ -64124,9 +64676,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *417 examples: - default: *416 + default: *418 '404': *6 x-github: githubCloudOnly: false @@ -64146,9 +64698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *354 - - *355 - - *417 + - *356 + - *357 + - *419 responses: '204': description: Response @@ -64172,8 +64724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response if Dependabot is enabled @@ -64221,8 +64773,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -64243,8 +64795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -64264,8 +64816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *354 - - *355 + - *356 + - *357 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -64303,7 +64855,7 @@ paths: - url protected: type: boolean - protection: &419 + protection: &421 title: Branch Protection description: Branch Protection type: object @@ -64345,7 +64897,7 @@ paths: required: - contexts - checks - enforce_admins: &422 + enforce_admins: &424 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -64360,7 +64912,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &424 + required_pull_request_reviews: &426 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -64436,7 +64988,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &421 + restrictions: &423 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -64713,9 +65265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *354 - - *355 - - &420 + - *356 + - *357 + - &422 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -64729,14 +65281,14 @@ paths: description: Response content: application/json: - schema: &430 + schema: &432 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &489 + commit: &491 title: Commit description: Commit type: object @@ -64770,7 +65322,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &418 + properties: &420 name: type: string example: '"Chris Wanstrath"' @@ -64786,7 +65338,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true message: type: string @@ -64807,7 +65359,7 @@ paths: required: - sha - url - verification: &542 + verification: &544 title: Verification type: object properties: @@ -64877,7 +65429,7 @@ paths: type: integer files: type: array - items: &502 + items: &504 title: Diff Entry description: Diff Entry type: object @@ -64961,7 +65513,7 @@ paths: - self protected: type: boolean - protection: *419 + protection: *421 protection_url: type: string format: uri @@ -65068,7 +65620,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *358 + '301': *360 '404': *6 x-github: githubCloudOnly: false @@ -65090,15 +65642,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *419 + schema: *421 examples: default: value: @@ -65292,9 +65844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -65549,7 +66101,7 @@ paths: url: type: string format: uri - required_status_checks: &427 + required_status_checks: &429 title: Status Check Policy description: Status Check Policy type: object @@ -65701,7 +66253,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *421 + restrictions: *423 required_conversation_resolution: type: object properties: @@ -65813,9 +66365,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65840,17 +66392,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: &423 + default: &425 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -65872,17 +66424,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: *423 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65901,9 +66453,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65928,17 +66480,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: &425 + default: &427 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -66034,9 +66586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66134,9 +66686,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: *425 + default: *427 '422': *15 x-github: githubCloudOnly: false @@ -66157,9 +66709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -66186,17 +66738,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: &426 + default: &428 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -66219,17 +66771,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: *426 + default: *428 '404': *6 x-github: githubCloudOnly: false @@ -66249,9 +66801,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -66276,17 +66828,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *427 + schema: *429 examples: - default: &428 + default: &430 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -66312,9 +66864,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66366,9 +66918,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *429 examples: - default: *428 + default: *430 '404': *6 '422': *15 x-github: @@ -66390,9 +66942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -66416,9 +66968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66452,9 +67004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66521,9 +67073,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66587,9 +67139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: content: application/json: @@ -66655,15 +67207,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *421 + schema: *423 examples: default: value: @@ -66754,9 +67306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -66779,9 +67331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66791,7 +67343,7 @@ paths: type: array items: *5 examples: - default: &429 + default: &431 value: - id: 1 slug: octoapp @@ -66848,9 +67400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66884,7 +67436,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -66905,9 +67457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66941,7 +67493,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -66962,9 +67514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66998,7 +67550,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -67020,9 +67572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -67052,9 +67604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -67113,9 +67665,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -67174,9 +67726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: content: application/json: @@ -67235,9 +67787,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -67271,9 +67823,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67331,9 +67883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67391,9 +67943,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67453,9 +68005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67477,7 +68029,7 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: default: value: @@ -67593,8 +68145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -67873,7 +68425,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &433 title: CheckRun description: A check performed on the code of a given code change type: object @@ -67993,7 +68545,7 @@ paths: check. type: array items: *93 - deployment: &782 + deployment: &797 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -68273,9 +68825,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *354 - - *355 - - &432 + - *356 + - *357 + - &434 name: check_run_id description: The unique identifier of the check run. in: path @@ -68287,9 +68839,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *433 examples: - default: &433 + default: &435 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -68389,9 +68941,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 requestBody: required: true content: @@ -68631,9 +69183,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *433 examples: - default: *433 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68653,9 +69205,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 - *17 - *19 responses: @@ -68750,9 +69302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 responses: '201': description: Response @@ -68796,8 +69348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -68819,7 +69371,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &436 + schema: &438 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -68905,12 +69457,12 @@ paths: type: string format: date-time nullable: true - head_commit: &810 + head_commit: &825 title: Simple Commit description: A commit. type: object - properties: *434 - required: *435 + properties: *436 + required: *437 latest_check_runs_count: type: integer check_runs_url: @@ -68938,7 +69490,7 @@ paths: - check_runs_url - pull_requests examples: - default: &437 + default: &439 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -69229,9 +69781,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *436 + schema: *438 examples: - default: *437 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69250,8 +69802,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -69560,9 +70112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *354 - - *355 - - &438 + - *356 + - *357 + - &440 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -69574,9 +70126,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *438 examples: - default: *437 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69599,17 +70151,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *354 - - *355 - - *438 - - &495 + - *356 + - *357 + - *440 + - &497 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &496 + - &498 name: status description: Returns check runs with the specified `status`. in: query @@ -69648,9 +70200,9 @@ paths: type: integer check_runs: type: array - items: *431 + items: *433 examples: - default: &497 + default: &499 value: total_count: 1 check_runs: @@ -69752,9 +70304,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *354 - - *355 - - *438 + - *356 + - *357 + - *440 responses: '201': description: Response @@ -69783,8 +70335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *62 - *47 @@ -69806,7 +70358,7 @@ paths: application/json: schema: type: array - items: &439 + items: &441 description: Code quality finding type: object properties: @@ -69936,7 +70488,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': &440 + '403': &442 description: Response if the user is not authorized to access Code quality for this repository. content: @@ -69963,8 +70515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding parameters: - - *354 - - *355 + - *356 + - *357 - name: finding_number in: path description: The number that identifies a finding. @@ -69976,7 +70528,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *441 examples: default: value: @@ -70005,7 +70557,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': *440 + '403': *442 '404': *6 '503': *122 x-github: @@ -70027,8 +70579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -70092,7 +70644,7 @@ paths: runner_label: updated_at: '2023-01-01T00:00:00Z' schedule: weekly - '403': *440 + '403': *442 '404': *6 '503': *122 x-github: @@ -70113,8 +70665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -70242,21 +70794,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *354 - - *355 - - *441 - - *442 + - *356 + - *357 + - *443 + - *444 - *19 - *17 - - &459 + - &461 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *443 - - &460 + schema: *445 + - &462 name: pr description: The number of the pull request for the results you want to list. in: query @@ -70281,13 +70833,13 @@ paths: be returned. in: query required: false - schema: *444 + schema: *446 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *445 + schema: *447 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -70311,7 +70863,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *446 + instances_url: *448 state: *197 fixed_at: *193 dismissed_by: @@ -70322,11 +70874,11 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *447 - dismissed_comment: *448 - rule: *449 - tool: *450 - most_recent_instance: *451 + dismissed_reason: *449 + dismissed_comment: *450 + rule: *451 + tool: *452 + most_recent_instance: *453 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -70452,7 +71004,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &452 + '403': &454 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -70479,9 +71031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *354 - - *355 - - &453 + - *356 + - *357 + - &455 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -70495,7 +71047,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &456 type: object properties: number: *188 @@ -70503,7 +71055,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *446 + instances_url: *448 state: *197 fixed_at: *193 dismissed_by: @@ -70514,8 +71066,8 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *447 - dismissed_comment: *448 + dismissed_reason: *449 + dismissed_comment: *450 rule: type: object properties: @@ -70569,8 +71121,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *450 - most_recent_instance: *451 + tool: *452 + most_recent_instance: *453 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -70669,7 +71221,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -70689,9 +71241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: true content: @@ -70706,8 +71258,8 @@ paths: enum: - open - dismissed - dismissed_reason: *447 - dismissed_comment: *448 + dismissed_reason: *449 + dismissed_comment: *450 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -70735,7 +71287,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *456 examples: default: value: @@ -70811,7 +71363,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &458 + '403': &460 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -70838,15 +71390,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 responses: '200': description: Response content: application/json: - schema: &455 + schema: &457 type: object properties: status: @@ -70872,13 +71424,13 @@ paths: - description - started_at examples: - default: &456 + default: &458 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &457 + '400': &459 description: Bad Request content: application/json: @@ -70889,7 +71441,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *452 + '403': *454 '404': *6 '500': *55 x-github: @@ -70914,29 +71466,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 responses: '200': description: OK content: application/json: - schema: *455 + schema: *457 examples: - default: *456 + default: *458 '202': description: Accepted content: application/json: - schema: *455 + schema: *457 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *457 + '400': *459 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -70968,9 +71520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: false content: @@ -71015,8 +71567,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *457 - '403': *458 + '400': *459 + '403': *460 '404': *6 '422': description: Unprocessable Entity @@ -71040,13 +71592,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 - *19 - *17 - - *459 - - *460 + - *461 + - *462 responses: '200': description: Response @@ -71057,10 +71609,10 @@ paths: items: type: object properties: - ref: *443 - analysis_key: *461 - environment: *462 - category: *463 + ref: *445 + analysis_key: *463 + environment: *464 + category: *465 state: type: string description: State of a code scanning alert instance. @@ -71075,7 +71627,7 @@ paths: properties: text: type: string - location: *464 + location: *466 html_url: type: string classifications: @@ -71083,7 +71635,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *465 + items: *467 examples: default: value: @@ -71120,7 +71672,7 @@ paths: end_column: 50 classifications: - source - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71154,25 +71706,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *354 - - *355 - - *441 - - *442 + - *356 + - *357 + - *443 + - *444 - *19 - *17 - - *460 + - *462 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *443 + schema: *445 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &466 + schema: &468 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -71193,23 +71745,23 @@ paths: application/json: schema: type: array - items: &467 + items: &469 type: object properties: - ref: *443 - commit_sha: &475 + ref: *445 + commit_sha: &477 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 64 pattern: "^([0-9a-fA-F]{40}(?:[0-9a-fA-F]{24})?)$" - analysis_key: *461 + analysis_key: *463 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *463 + category: *465 error: type: string example: error reading field xyz @@ -71233,8 +71785,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *466 - tool: *450 + sarif_id: *468 + tool: *452 deletable: type: boolean warning: @@ -71295,7 +71847,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71331,8 +71883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -71345,7 +71897,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *469 examples: response: summary: application/json response @@ -71399,7 +71951,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *452 + '403': *454 '404': *6 '422': description: Response if analysis could not be processed @@ -71486,8 +72038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -71540,7 +72092,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *458 + '403': *460 '404': *6 '503': *122 x-github: @@ -71562,8 +72114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -71571,7 +72123,7 @@ paths: application/json: schema: type: array - items: &468 + items: &470 title: CodeQL Database description: A CodeQL database. type: object @@ -71682,7 +72234,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71711,8 +72263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: language in: path description: The language of the CodeQL database. @@ -71724,7 +72276,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *470 examples: default: value: @@ -71756,9 +72308,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &506 + '302': &508 description: Found - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71780,8 +72332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *354 - - *355 + - *356 + - *357 - name: language in: path description: The language of the CodeQL database. @@ -71791,7 +72343,7 @@ paths: responses: '204': description: Response - '403': *458 + '403': *460 '404': *6 '503': *122 x-github: @@ -71819,8 +72371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -71829,7 +72381,7 @@ paths: type: object additionalProperties: false properties: - language: &469 + language: &471 type: string description: The language targeted by the CodeQL query enum: @@ -71909,7 +72461,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &473 + schema: &475 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -71919,7 +72471,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *469 + query_language: *471 query_pack_url: type: string description: The download url for the query pack. @@ -71966,7 +72518,7 @@ paths: items: type: object properties: - repository: &470 + repository: &472 title: Repository Identifier description: Repository Identifier type: object @@ -72002,7 +72554,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &474 + analysis_status: &476 type: string description: The new status of the CodeQL variant analysis repository task. @@ -72034,7 +72586,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &471 + access_mismatch_repos: &473 type: object properties: repository_count: @@ -72048,7 +72600,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *470 + items: *472 required: - repository_count - repositories @@ -72070,8 +72622,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *471 - over_limit_repos: *471 + no_codeql_db_repos: *473 + over_limit_repos: *473 required: - access_mismatch_repos - not_found_repos @@ -72087,7 +72639,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &472 + value: &474 summary: Default response value: id: 1 @@ -72233,10 +72785,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *472 + value: *474 repository_lists: summary: Response for a successful variant analysis submission - value: *472 + value: *474 '404': *6 '422': description: Unable to process variant analysis submission @@ -72264,8 +72816,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *354 - - *355 + - *356 + - *357 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -72277,9 +72829,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: *472 + default: *474 '404': *6 '503': *122 x-github: @@ -72302,7 +72854,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *354 + - *356 - name: repo in: path description: The name of the controller repository. @@ -72337,7 +72889,7 @@ paths: type: object properties: repository: *67 - analysis_status: *474 + analysis_status: *476 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -72462,8 +73014,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -72548,7 +73100,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -72569,8 +73121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -72662,7 +73214,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *458 + '403': *460 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -72733,8 +73285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -72742,7 +73294,7 @@ paths: schema: type: object properties: - commit_sha: *475 + commit_sha: *477 ref: type: string description: |- @@ -72800,7 +73352,7 @@ paths: schema: type: object properties: - id: *466 + id: *468 url: type: string description: The REST API URL for checking the status of the upload. @@ -72814,7 +73366,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *458 + '403': *460 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -72837,8 +73389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *354 - - *355 + - *356 + - *357 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -72884,7 +73436,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *452 + '403': *454 '404': description: Not Found if the sarif id does not match any upload '503': *122 @@ -72909,8 +73461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -72991,8 +73543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -73112,8 +73664,8 @@ paths: parameters: - *17 - *19 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -73427,8 +73979,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -73493,7 +74045,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -73501,7 +74053,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '400': *14 '401': *25 '403': *29 @@ -73530,8 +74082,8 @@ paths: parameters: - *17 - *19 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -73595,8 +74147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -73631,14 +74183,14 @@ paths: type: integer machines: type: array - items: &724 + items: &739 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *477 - required: *478 + properties: *479 + required: *480 examples: - default: &725 + default: &740 value: total_count: 2 machines: @@ -73678,8 +74230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -73763,8 +74315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -73830,8 +74382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -73849,7 +74401,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &484 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -73869,7 +74421,7 @@ paths: - created_at - updated_at examples: - default: *479 + default: *481 headers: Link: *70 x-github: @@ -73892,16 +74444,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *480 + schema: *482 examples: - default: *481 + default: *483 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73921,17 +74473,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *482 + schema: *484 examples: - default: *483 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73951,8 +74503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -74005,8 +74557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -74035,8 +74587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *354 - - *355 + - *356 + - *357 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -74078,7 +74630,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &484 + properties: &486 login: type: string example: octocat @@ -74171,7 +74723,7 @@ paths: user_view_type: type: string example: public - required: &485 + required: &487 - avatar_url - events_url - followers_url @@ -74245,8 +74797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '204': @@ -74293,8 +74845,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 requestBody: required: false @@ -74321,7 +74873,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &556 + schema: &558 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -74550,8 +75102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '204': @@ -74583,8 +75135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '200': @@ -74605,8 +75157,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *484 - required: *485 + properties: *486 + required: *487 nullable: true required: - permission @@ -74661,8 +75213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -74672,7 +75224,7 @@ paths: application/json: schema: type: array - items: &486 + items: &488 title: Commit Comment description: Commit Comment type: object @@ -74730,7 +75282,7 @@ paths: - created_at - updated_at examples: - default: &491 + default: &493 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -74789,17 +75341,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *486 + schema: *488 examples: - default: &492 + default: &494 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -74856,8 +75408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -74880,7 +75432,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *488 examples: default: value: @@ -74931,8 +75483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -74954,8 +75506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -74982,7 +75534,7 @@ paths: application/json: schema: type: array - items: &487 + items: &489 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -75025,7 +75577,7 @@ paths: - content - created_at examples: - default: &561 + default: &563 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -75070,8 +75622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -75104,9 +75656,9 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: &488 + default: &490 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -75135,9 +75687,9 @@ paths: description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -75159,10 +75711,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - &562 + - &564 name: reaction_id description: The unique identifier of the reaction. in: path @@ -75217,8 +75769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *354 - - *355 + - *356 + - *357 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -75274,9 +75826,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: &629 + default: &631 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -75370,9 +75922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *354 - - *355 - - &490 + - *356 + - *357 + - &492 name: commit_sha description: The SHA of the commit. in: path @@ -75444,9 +75996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 - *17 - *19 responses: @@ -75456,9 +76008,9 @@ paths: application/json: schema: type: array - items: *486 + items: *488 examples: - default: *491 + default: *493 headers: Link: *70 x-github: @@ -75486,9 +76038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 requestBody: required: true content: @@ -75523,9 +76075,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *488 examples: - default: *492 + default: *494 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75553,9 +76105,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 - *17 - *19 responses: @@ -75565,9 +76117,9 @@ paths: application/json: schema: type: array - items: *493 + items: *495 examples: - default: &621 + default: &623 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -76104,11 +76656,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 - - &494 + - &496 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -76123,9 +76675,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *491 examples: - default: &608 + default: &610 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -76213,7 +76765,7 @@ paths: schema: type: string examples: - default: &503 + default: &505 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -76226,7 +76778,7 @@ paths: schema: type: string examples: - default: &504 + default: &506 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -76279,11 +76831,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *354 - - *355 - - *494 - - *495 + - *356 + - *357 - *496 + - *497 + - *498 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -76317,9 +76869,9 @@ paths: type: integer check_runs: type: array - items: *431 + items: *433 examples: - default: *497 + default: *499 headers: Link: *70 x-github: @@ -76344,9 +76896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -76354,7 +76906,7 @@ paths: schema: type: integer example: 1 - - *495 + - *497 - *17 - *19 responses: @@ -76372,7 +76924,7 @@ paths: type: integer check_suites: type: array - items: *436 + items: *438 examples: default: value: @@ -76572,9 +77124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - *17 - *19 responses: @@ -76772,9 +77324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - *17 - *19 responses: @@ -76784,7 +77336,7 @@ paths: application/json: schema: type: array - items: &702 + items: &717 title: Status description: The status of a commit. type: object @@ -76865,7 +77417,7 @@ paths: site_admin: false headers: Link: *70 - '301': *358 + '301': *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76893,8 +77445,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -76923,20 +77475,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *498 - required: *499 + properties: *500 + required: *501 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &500 + properties: &502 url: type: string format: uri html_url: type: string format: uri - required: &501 + required: &503 - url - html_url nullable: true @@ -76950,26 +77502,26 @@ paths: contributing: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true readme: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true issue_template: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true pull_request_template: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true required: - code_of_conduct @@ -77096,8 +77648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 - name: basehead @@ -77140,8 +77692,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *489 - merge_base_commit: *489 + base_commit: *491 + merge_base_commit: *491 status: type: string enum: @@ -77161,10 +77713,10 @@ paths: example: 6 commits: type: array - items: *489 + items: *491 files: type: array - items: *502 + items: *504 required: - url - html_url @@ -77410,12 +77962,12 @@ paths: schema: type: string examples: - default: *503 + default: *505 application/vnd.github.patch: schema: type: string examples: - default: *504 + default: *506 '404': *6 '500': *55 '503': *122 @@ -77460,8 +78012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -77621,7 +78173,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &505 + response-if-content-is-a-file-github-object: &507 summary: Response if content is a file value: type: file @@ -77753,7 +78305,7 @@ paths: - size - type - url - - &634 + - &636 title: Content File description: Content File type: object @@ -77954,7 +78506,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *505 + response-if-content-is-a-file: *507 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -78023,7 +78575,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *506 + '302': *508 '304': *37 x-github: githubCloudOnly: false @@ -78046,8 +78598,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -78140,7 +78692,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &509 title: File Commit description: File Commit type: object @@ -78292,7 +78844,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *509 examples: example-for-creating-a-file: value: @@ -78346,7 +78898,7 @@ paths: schema: oneOf: - *3 - - &537 + - &539 description: Repository rule violation was detected type: object properties: @@ -78367,7 +78919,7 @@ paths: items: type: object properties: - placeholder_id: &694 + placeholder_id: &709 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -78399,8 +78951,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -78461,7 +79013,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *509 examples: default: value: @@ -78516,8 +79068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *354 - - *355 + - *356 + - *357 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -78646,8 +79198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-cloud-agent-management#get-copilot-cloud-agent-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -78779,8 +79331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *212 - *213 - *214 @@ -78793,7 +79345,7 @@ paths: schema: type: string - *217 - - *508 + - *510 - *218 - *219 - *220 @@ -78808,7 +79360,7 @@ paths: application/json: schema: type: array - items: &512 + items: &514 type: object description: A Dependabot alert. properties: @@ -78855,7 +79407,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *509 + security_advisory: *511 security_vulnerability: *66 url: *191 html_url: *192 @@ -78886,8 +79438,8 @@ paths: nullable: true maxLength: 280 fixed_at: *193 - auto_dismissed_at: *510 - dismissal_request: *511 + auto_dismissed_at: *512 + dismissal_request: *513 assignees: type: array description: The users assigned to this alert. @@ -79142,9 +79694,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *354 - - *355 - - &513 + - *356 + - *357 + - &515 name: alert_number in: path description: |- @@ -79159,7 +79711,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -79291,9 +79843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *354 - - *355 - - *513 + - *356 + - *357 + - *515 requestBody: required: true content: @@ -79366,7 +79918,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -79496,8 +80048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -79515,7 +80067,7 @@ paths: type: integer secrets: type: array - items: &516 + items: &518 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -79568,16 +80120,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *514 + schema: *516 examples: - default: *515 + default: *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79597,15 +80149,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *516 + schema: *518 examples: default: value: @@ -79631,8 +80183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -79685,8 +80237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -79709,8 +80261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *354 - - *355 + - *356 + - *357 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -79873,8 +80425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -80112,8 +80664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: sbom_uuid in: path required: true @@ -80124,7 +80676,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *517 + Location: *519 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -80145,8 +80697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -80184,8 +80736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -80260,7 +80812,7 @@ paths: - version - url additionalProperties: false - metadata: &518 + metadata: &520 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -80293,7 +80845,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *518 + metadata: *520 resolved: type: object description: A collection of resolved package dependencies. @@ -80306,7 +80858,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *518 + metadata: *520 relationship: type: string description: A notation of whether a dependency is requested @@ -80435,8 +80987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *354 - - *355 + - *356 + - *357 - name: sha description: The SHA recorded at creation time. in: query @@ -80476,9 +81028,9 @@ paths: application/json: schema: type: array - items: *519 + items: *521 examples: - default: *520 + default: *522 headers: Link: *70 x-github: @@ -80544,8 +81096,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -80626,7 +81178,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: simple-example: summary: Simple example @@ -80699,9 +81251,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *354 - - *355 - - &521 + - *356 + - *357 + - &523 name: deployment_id description: deployment_id parameter in: path @@ -80713,7 +81265,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: default: value: @@ -80778,9 +81330,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 responses: '204': description: Response @@ -80802,9 +81354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 - *17 - *19 responses: @@ -80814,7 +81366,7 @@ paths: application/json: schema: type: array - items: &522 + items: &524 title: Deployment Status description: The status of a deployment. type: object @@ -80975,9 +81527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 requestBody: required: true content: @@ -81052,9 +81604,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *524 examples: - default: &523 + default: &525 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -81110,9 +81662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 - name: status_id in: path required: true @@ -81123,9 +81675,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *524 examples: - default: *523 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -81150,8 +81702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -81208,8 +81760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -81226,7 +81778,7 @@ paths: type: integer environments: type: array - items: &525 + items: &527 title: Environment description: Details of a deployment environment type: object @@ -81278,7 +81830,7 @@ paths: type: type: string example: wait_timer - wait_timer: &527 + wait_timer: &529 type: integer example: 30 description: The amount of time to delay a job after @@ -81315,7 +81867,7 @@ paths: items: type: object properties: - type: *524 + type: *526 reviewer: anyOf: - *4 @@ -81339,7 +81891,7 @@ paths: - id - node_id - type - deployment_branch_policy: &528 + deployment_branch_policy: &530 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -81455,9 +82007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *354 - - *355 - - &526 + - *356 + - *357 + - &528 name: environment_name in: path required: true @@ -81470,9 +82022,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: &529 + default: &531 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -81556,9 +82108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: false content: @@ -81567,7 +82119,7 @@ paths: type: object nullable: true properties: - wait_timer: *527 + wait_timer: *529 prevent_self_review: type: boolean example: false @@ -81584,13 +82136,13 @@ paths: items: type: object properties: - type: *524 + type: *526 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *528 + deployment_branch_policy: *530 additionalProperties: false examples: default: @@ -81610,9 +82162,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: *529 + default: *531 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -81636,9 +82188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 responses: '204': description: Default response @@ -81663,9 +82215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *17 - *19 responses: @@ -81683,7 +82235,7 @@ paths: example: 2 branch_policies: type: array - items: &530 + items: &532 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -81740,9 +82292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: true content: @@ -81788,9 +82340,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - example-wildcard: &531 + example-wildcard: &533 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -81832,10 +82384,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - &532 + - *356 + - *357 + - *528 + - &534 name: branch_policy_id in: path required: true @@ -81847,9 +82399,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81868,10 +82420,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - *532 + - *356 + - *357 + - *528 + - *534 requestBody: required: true content: @@ -81899,9 +82451,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81920,10 +82472,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - *532 + - *356 + - *357 + - *528 + - *534 responses: '204': description: Response @@ -81948,9 +82500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 responses: '200': description: List of deployment protection rules @@ -81966,7 +82518,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &533 + items: &535 title: Deployment protection rule description: Deployment protection rule type: object @@ -81985,7 +82537,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &534 + app: &536 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -82084,9 +82636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 requestBody: content: application/json: @@ -82107,9 +82659,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *533 + schema: *535 examples: - default: &535 + default: &537 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -82144,9 +82696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 - *19 - *17 responses: @@ -82165,7 +82717,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *534 + items: *536 examples: default: value: @@ -82200,10 +82752,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *354 - - *355 - - *526 - - &536 + - *356 + - *357 + - *528 + - &538 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -82215,9 +82767,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: *535 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82238,10 +82790,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *526 - - *355 - - *354 - - *536 + - *528 + - *357 + - *356 + - *538 responses: '204': description: Response @@ -82267,9 +82819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *17 - *19 responses: @@ -82287,9 +82839,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -82314,9 +82866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 responses: '200': description: Response @@ -82346,18 +82898,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82379,9 +82931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 requestBody: required: true @@ -82439,9 +82991,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 responses: '204': @@ -82467,9 +83019,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *180 - *19 responses: @@ -82487,9 +83039,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -82512,9 +83064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: true content: @@ -82566,18 +83118,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *413 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82598,10 +83150,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 - - *526 + - *528 requestBody: required: true content: @@ -82643,10 +83195,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 - - *526 + - *528 responses: '204': description: Response @@ -82668,8 +83220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -82737,8 +83289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *354 - - *355 + - *356 + - *357 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -82897,8 +83449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -82930,9 +83482,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 '400': *14 '422': *15 '403': *29 @@ -82953,8 +83505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83014,7 +83566,7 @@ paths: schema: oneOf: - *132 - - *537 + - *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83039,8 +83591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *354 - - *355 + - *356 + - *357 - name: file_sha in: path required: true @@ -83139,8 +83691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83249,7 +83801,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &540 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -83463,15 +84015,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 responses: '200': description: Response content: application/json: - schema: *538 + schema: *540 examples: default: value: @@ -83527,9 +84079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *354 - - *355 - - &539 + - *356 + - *357 + - &541 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -83546,7 +84098,7 @@ paths: application/json: schema: type: array - items: &540 + items: &542 title: Git Reference description: Git references within a repository type: object @@ -83621,17 +84173,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 responses: '200': description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: &541 + default: &543 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -83660,8 +84212,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83690,9 +84242,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: *541 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -83718,9 +84270,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 requestBody: required: true content: @@ -83749,9 +84301,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: *541 + default: *543 '422': *15 '409': *54 x-github: @@ -83769,9 +84321,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 responses: '204': description: Response @@ -83826,8 +84378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83894,7 +84446,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &545 title: Git Tag description: Metadata for a Git tag type: object @@ -83945,7 +84497,7 @@ paths: - sha - type - url - verification: *542 + verification: *544 required: - sha - url @@ -83955,7 +84507,7 @@ paths: - tag - message examples: - default: &544 + default: &546 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -84028,8 +84580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *354 - - *355 + - *356 + - *357 - name: tag_sha in: path required: true @@ -84040,9 +84592,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *545 examples: - default: *544 + default: *546 '404': *6 '409': *54 x-github: @@ -84066,8 +84618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -84140,7 +84692,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &547 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -84236,8 +84788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *354 - - *355 + - *356 + - *357 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -84260,7 +84812,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *547 examples: default-response: summary: Default response @@ -84318,8 +84870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-the-hash-algorithm-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -84362,8 +84914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -84373,7 +84925,7 @@ paths: application/json: schema: type: array - items: &546 + items: &548 title: Webhook description: Webhooks for repositories. type: object @@ -84427,7 +84979,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &818 + last_response: &833 title: Hook Response type: object properties: @@ -84501,8 +85053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -84554,9 +85106,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: &547 + default: &549 value: type: Repository id: 12345678 @@ -84604,17 +85156,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -84634,8 +85186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 requestBody: required: true @@ -84681,9 +85233,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '422': *15 '404': *6 x-github: @@ -84704,8 +85256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84730,8 +85282,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '200': @@ -84759,8 +85311,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *230 requestBody: required: false @@ -84805,8 +85357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *17 - *231 @@ -84839,8 +85391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *16 responses: @@ -84869,8 +85421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *16 responses: @@ -84894,8 +85446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84921,8 +85473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84946,8 +85498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response if immutable releases are enabled @@ -84993,8 +85545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '409': *54 @@ -85014,8 +85566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '409': *54 @@ -85072,14 +85624,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &548 + schema: &550 title: Import description: A repository import from an external source. type: object @@ -85178,7 +85730,7 @@ paths: - html_url - authors_url examples: - default: &551 + default: &553 value: vcs: subversion use_lfs: true @@ -85194,7 +85746,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &549 + '503': &551 description: Unavailable due to service under maintenance. content: application/json: @@ -85223,8 +85775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -85272,7 +85824,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: default: value: @@ -85297,7 +85849,7 @@ paths: type: string '422': *15 '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85325,8 +85877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -85375,7 +85927,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: example-1: summary: Example 1 @@ -85423,7 +85975,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85446,12 +85998,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85477,9 +86029,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *354 - - *355 - - &747 + - *356 + - *357 + - &762 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -85493,7 +86045,7 @@ paths: application/json: schema: type: array - items: &550 + items: &552 title: Porter Author description: Porter Author type: object @@ -85547,7 +86099,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85572,8 +86124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *354 - - *355 + - *356 + - *357 - name: author_id in: path required: true @@ -85603,7 +86155,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *552 examples: default: value: @@ -85616,7 +86168,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85640,8 +86192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85682,7 +86234,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85710,8 +86262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -85738,11 +86290,11 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *551 + default: *553 '422': *15 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85765,8 +86317,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85774,8 +86326,8 @@ paths: application/json: schema: *22 examples: - default: *552 - '301': *358 + default: *554 + '301': *360 '404': *6 x-github: githubCloudOnly: false @@ -85795,8 +86347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85809,7 +86361,7 @@ paths: properties: {} additionalProperties: false examples: - default: &554 + default: &556 value: limit: collaborators_only origin: repository @@ -85834,13 +86386,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *553 + schema: *555 examples: default: summary: Example request body @@ -85854,7 +86406,7 @@ paths: application/json: schema: *249 examples: - default: *554 + default: *556 '409': description: Response x-github: @@ -85876,8 +86428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -85904,8 +86456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85959,13 +86511,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#add-users-to-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: &555 + schema: &557 title: Interaction Limits Pull Request Bypass List description: A list of user logins to add or remove from the pull request creation cap bypass list. @@ -86015,13 +86567,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *555 + schema: *557 examples: default: summary: Example request body @@ -86054,8 +86606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -86108,8 +86660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -86185,8 +86737,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -86196,9 +86748,9 @@ paths: application/json: schema: type: array - items: *556 + items: *558 examples: - default: &740 + default: &755 value: - id: 1 repository: @@ -86329,8 +86881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *354 - - *355 + - *356 + - *357 - *253 requestBody: required: false @@ -86360,7 +86912,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *558 examples: default: value: @@ -86491,8 +87043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *354 - - *355 + - *356 + - *357 - *253 responses: '204': @@ -86516,8 +87068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/issue-types#list-issue-types-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -86527,7 +87079,7 @@ paths: type: array items: *257 examples: - default: *557 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -86556,8 +87108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *354 - - *355 + - *356 + - *357 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -86644,7 +87196,7 @@ paths: type: array items: *88 examples: - default: &572 + default: &574 value: - id: 1 node_id: MDU6SXNzdWUx @@ -86793,7 +87345,7 @@ paths: state_reason: completed headers: Link: *70 - '301': *358 + '301': *360 '422': *15 '404': *6 x-github: @@ -86822,8 +87374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -86932,7 +87484,7 @@ paths: application/json: schema: *88 examples: - default: &569 + default: &571 value: id: 1 node_id: MDU6SXNzdWUx @@ -87089,7 +87641,7 @@ paths: '422': *15 '503': *122 '404': *6 - '410': *558 + '410': *560 x-github: triggersNotification: true githubCloudOnly: false @@ -87117,8 +87669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -87139,9 +87691,9 @@ paths: application/json: schema: type: array - items: *559 + items: *561 examples: - default: &571 + default: &573 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87200,17 +87752,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: &560 + default: &562 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87266,8 +87818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -87290,9 +87842,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *560 + default: *562 '422': *15 x-github: githubCloudOnly: false @@ -87310,8 +87862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -87340,15 +87892,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *559 + schema: *561 examples: default: value: @@ -87404,7 +87956,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -87421,8 +87973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -87430,7 +87982,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 '503': *122 x-github: githubCloudOnly: false @@ -87448,8 +88000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87476,9 +88028,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -87499,8 +88051,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -87533,16 +88085,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -87564,10 +88116,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - *562 + - *564 responses: '204': description: Response @@ -87587,8 +88139,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -87598,7 +88150,7 @@ paths: application/json: schema: type: array - items: &568 + items: &570 title: Issue Event description: Issue Event type: object @@ -87641,8 +88193,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *563 - required: *564 + properties: *565 + required: *566 nullable: true label: title: Issue Event Label @@ -87751,7 +88303,7 @@ paths: required: - from - to - issue_type: &565 + issue_type: &567 title: Issue Type description: The type of issue. type: object @@ -87779,14 +88331,14 @@ paths: required: - id - name - prev_issue_type: *565 + prev_issue_type: *567 sub_issue: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: &566 + properties: &568 number: type: integer description: The number of the referenced issue. @@ -87824,7 +88376,7 @@ paths: - id - node_id - name - required: &567 + required: &569 - number - title - state @@ -87836,24 +88388,24 @@ paths: event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 blocked_by: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 blocking: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 author_association: *85 lock_reason: type: string @@ -88053,8 +88605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *354 - - *355 + - *356 + - *357 - name: event_id in: path required: true @@ -88065,7 +88617,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *570 examples: default: value: @@ -88258,7 +88810,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *558 + '410': *560 '403': *29 x-github: githubCloudOnly: false @@ -88292,9 +88844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *354 - - *355 - - &570 + - *356 + - *357 + - &572 name: issue_number description: The number that identifies the issue. in: path @@ -88310,7 +88862,7 @@ paths: examples: default: summary: Issue - value: *569 + value: *571 pinned_comment: summary: Issue with pinned comment value: @@ -88509,9 +89061,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 '304': *37 x-github: githubCloudOnly: false @@ -88536,9 +89088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -88683,13 +89235,13 @@ paths: - type: object properties: {} examples: - default: *569 + default: *571 '422': *15 '503': *122 '403': *29 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88707,9 +89259,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -88737,7 +89289,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88753,9 +89305,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: content: application/json: @@ -88782,7 +89334,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88804,9 +89356,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: assignee in: path required: true @@ -88846,9 +89398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *95 - *17 - *19 @@ -88859,13 +89411,13 @@ paths: application/json: schema: type: array - items: *559 + items: *561 examples: - default: *571 + default: *573 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88894,9 +89446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -88918,16 +89470,16 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *560 + default: *562 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -88955,9 +89507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -88969,12 +89521,12 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89002,9 +89554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -89028,15 +89580,15 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *358 + '301': *360 '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -89067,9 +89619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -89083,13 +89635,13 @@ paths: application/json: schema: *88 examples: - default: *569 - '301': *358 + default: *571 + '301': *360 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 x-github: triggersNotification: true githubCloudOnly: false @@ -89115,9 +89667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -89129,12 +89681,12 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89151,9 +89703,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -89167,7 +89719,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &576 + - &578 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -89221,7 +89773,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &577 + - &579 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -89357,7 +89909,7 @@ paths: - performed_via_github_app - assignee - assigner - - &578 + - &580 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -89408,7 +89960,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &579 + - &581 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -89459,7 +90011,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &580 + - &582 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -89513,7 +90065,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &581 + - &583 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -89560,7 +90112,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &582 + - &584 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -89607,7 +90159,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &583 + - &585 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -89667,7 +90219,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &584 + - &586 title: Locked Issue Event description: Locked Issue Event type: object @@ -89715,7 +90267,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &585 + - &587 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -89781,7 +90333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &586 + - &588 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -89847,7 +90399,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &587 + - &589 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -89913,7 +90465,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &588 + - &590 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -89969,7 +90521,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &593 + - &595 title: Issue Type Added Issue Event description: Issue Type Added Issue Event type: object @@ -90002,7 +90554,7 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *565 + issue_type: *567 required: - issue_type - id @@ -90014,7 +90566,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &594 + - &596 title: Issue Type Removed Issue Event description: Issue Type Removed Issue Event type: object @@ -90047,7 +90599,7 @@ paths: nullable: true properties: *83 required: *84 - prev_issue_type: *565 + prev_issue_type: *567 required: - prev_issue_type - id @@ -90059,7 +90611,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &595 + - &597 title: Issue Type Changed Issue Event description: Issue Type Changed Issue Event type: object @@ -90092,8 +90644,8 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *565 - prev_issue_type: *565 + issue_type: *567 + prev_issue_type: *567 required: - issue_type - prev_issue_type @@ -90106,7 +90658,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &596 + - &598 title: Sub-issue Added Issue Event description: Sub-issue Added Issue Event type: object @@ -90146,8 +90698,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - sub_issue - id @@ -90159,7 +90711,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &597 + - &599 title: Sub-issue Removed Issue Event description: Sub-issue Removed Issue Event type: object @@ -90199,8 +90751,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - sub_issue - id @@ -90212,7 +90764,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &598 + - &600 title: Parent-issue Added Issue Event description: Parent-issue Added Issue Event type: object @@ -90252,8 +90804,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - parent_issue - id @@ -90265,7 +90817,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &599 + - &601 title: Parent-issue Removed Issue Event description: Parent-issue Removed Issue Event type: object @@ -90305,8 +90857,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - parent_issue - id @@ -90318,7 +90870,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &600 + - &602 title: Blocked-by Added Issue Event description: Blocked-by Added Issue Event type: object @@ -90358,8 +90910,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocked_by - id @@ -90371,7 +90923,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &601 + - &603 title: Blocked-by Removed Issue Event description: Blocked-by Removed Issue Event type: object @@ -90411,8 +90963,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocked_by - id @@ -90424,7 +90976,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &602 + - &604 title: Blocking Added Issue Event description: Blocking Added Issue Event type: object @@ -90464,8 +91016,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocking - id @@ -90477,7 +91029,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &603 + - &605 title: Blocking Removed Issue Event description: Blocking Removed Issue Event type: object @@ -90517,8 +91069,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocking - id @@ -90565,7 +91117,7 @@ paths: color: red headers: Link: *70 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90582,9 +91134,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -90594,9 +91146,9 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: &574 + default: &576 value: - issue_field_id: 1 issue_field_name: DRI @@ -90636,9 +91188,9 @@ paths: color: green headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90667,9 +91219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90739,9 +91291,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *573 + items: *575 examples: - default: *574 + default: *576 '400': *14 '403': *29 '404': *6 @@ -90777,9 +91329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90844,9 +91396,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *573 + items: *575 examples: - default: *574 + default: *576 '400': *14 '403': *29 '404': *6 @@ -90877,9 +91429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *256 responses: '204': @@ -90905,9 +91457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -90919,7 +91471,7 @@ paths: type: array items: *87 examples: - default: &575 + default: &577 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -90937,9 +91489,9 @@ paths: default: false headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90955,9 +91507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -91002,10 +91554,10 @@ paths: type: array items: *87 examples: - default: *575 - '301': *358 + default: *577 + '301': *360 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -91022,9 +91574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -91086,10 +91638,10 @@ paths: type: array items: *87 examples: - default: *575 - '301': *358 + default: *577 + '301': *360 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -91106,15 +91658,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '204': description: Response - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91133,9 +91685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: name in: path required: true @@ -91159,9 +91711,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91181,9 +91733,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -91211,7 +91763,7 @@ paths: '204': description: Response '403': *29 - '410': *558 + '410': *560 '404': *6 '422': *15 x-github: @@ -91229,9 +91781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '204': description: Response @@ -91261,9 +91813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '200': description: Response @@ -91271,10 +91823,10 @@ paths: application/json: schema: *88 examples: - default: *569 - '301': *358 + default: *571 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91291,9 +91843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -91319,13 +91871,13 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91343,9 +91895,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91377,16 +91929,16 @@ paths: description: Response content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Response content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -91408,10 +91960,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *354 - - *355 - - *570 - - *562 + - *356 + - *357 + - *572 + - *564 responses: '204': description: Response @@ -91440,9 +91992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91466,7 +92018,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -91499,9 +92051,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -91513,11 +92065,11 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91545,9 +92097,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91576,14 +92128,14 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -91603,9 +92155,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91638,7 +92190,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 '403': *29 '404': *6 '422': *7 @@ -91660,9 +92212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -91677,8 +92229,6 @@ paths: description: Timeline Event type: object anyOf: - - *576 - - *577 - *578 - *579 - *580 @@ -91690,6 +92240,8 @@ paths: - *586 - *587 - *588 + - *589 + - *590 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -91750,15 +92302,15 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true required: - event @@ -92013,7 +92565,7 @@ paths: type: string comments: type: array - items: &623 + items: &625 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -92228,7 +92780,7 @@ paths: type: string comments: type: array - items: *486 + items: *488 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -92362,8 +92914,6 @@ paths: - commit_url - created_at - performed_via_github_app - - *593 - - *594 - *595 - *596 - *597 @@ -92373,6 +92923,8 @@ paths: - *601 - *602 - *603 + - *604 + - *605 examples: default: value: @@ -92529,7 +93081,7 @@ paths: Link: *70 '404': *6 '400': *14 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92546,8 +93098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -92557,7 +93109,7 @@ paths: application/json: schema: type: array - items: &604 + items: &606 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -92623,8 +93175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92660,9 +93212,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: &605 + default: &607 value: id: 1 key: ssh-rsa AAA... @@ -92696,9 +93248,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *354 - - *355 - - &606 + - *356 + - *357 + - &608 name: key_id description: The unique identifier of the key. in: path @@ -92710,9 +93262,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: *605 + default: *607 '404': *6 x-github: githubCloudOnly: false @@ -92730,9 +93282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *354 - - *355 - - *606 + - *356 + - *357 + - *608 responses: '204': description: Response @@ -92752,8 +93304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -92765,7 +93317,7 @@ paths: type: array items: *87 examples: - default: *575 + default: *577 headers: Link: *70 '404': *6 @@ -92786,8 +93338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92825,7 +93377,7 @@ paths: application/json: schema: *87 examples: - default: &607 + default: &609 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92857,8 +93409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92871,7 +93423,7 @@ paths: application/json: schema: *87 examples: - default: *607 + default: *609 '404': *6 x-github: githubCloudOnly: false @@ -92888,8 +93440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92954,8 +93506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92981,8 +93533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -93021,9 +93573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *354 - - *355 - - *459 + - *356 + - *357 + - *461 responses: '200': description: Response @@ -93168,8 +93720,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93234,8 +93786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93269,9 +93821,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *489 + schema: *491 examples: - default: *608 + default: *610 '204': description: Response when already merged '404': @@ -93296,8 +93848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *354 - - *355 + - *356 + - *357 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -93338,7 +93890,7 @@ paths: application/json: schema: type: array - items: &609 + items: &611 title: Milestone description: A collection of related issues and pull requests. type: object @@ -93399,8 +93951,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93440,9 +93992,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: &610 + default: &612 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -93501,9 +94053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *354 - - *355 - - &611 + - *356 + - *357 + - &613 name: milestone_number description: The number that identifies the milestone. in: path @@ -93515,9 +94067,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: *610 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -93534,9 +94086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 requestBody: required: false content: @@ -93574,9 +94126,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: *610 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93592,9 +94144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 responses: '204': description: Response @@ -93615,9 +94167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 - *17 - *19 responses: @@ -93629,7 +94181,7 @@ paths: type: array items: *87 examples: - default: *575 + default: *577 headers: Link: *70 x-github: @@ -93648,12 +94200,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *354 - - *355 - - *612 - - *613 - - *95 + - *356 + - *357 - *614 + - *615 + - *95 + - *616 - *17 - *19 responses: @@ -93665,7 +94217,7 @@ paths: type: array items: *115 examples: - default: *615 + default: *617 headers: Link: *70 x-github: @@ -93689,8 +94241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -93748,14 +94300,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &616 + schema: &618 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -93880,7 +94432,7 @@ paths: - custom_404 - public examples: - default: &617 + default: &619 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -93921,8 +94473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93976,9 +94528,9 @@ paths: description: Response content: application/json: - schema: *616 + schema: *618 examples: - default: *617 + default: *619 '422': *15 '409': *54 x-github: @@ -94001,8 +94553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -94101,8 +94653,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -94128,8 +94680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -94139,7 +94691,7 @@ paths: application/json: schema: type: array - items: &618 + items: &620 title: Page Build description: Page Build type: object @@ -94233,8 +94785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -94279,16 +94831,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *618 + schema: *620 examples: - default: &619 + default: &621 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -94336,8 +94888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *354 - - *355 + - *356 + - *357 - name: build_id in: path required: true @@ -94348,9 +94900,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *620 examples: - default: *619 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94370,8 +94922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -94476,9 +95028,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *354 - - *355 - - &620 + - *356 + - *357 + - &622 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -94536,9 +95088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *354 - - *355 - - *620 + - *356 + - *357 + - *622 responses: '204': *61 '404': *6 @@ -94565,8 +95117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -94824,8 +95376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Private vulnerability reporting status @@ -94862,8 +95414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '422': *14 @@ -94884,8 +95436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '422': *14 @@ -94907,8 +95459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -94947,8 +95499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -95010,8 +95562,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *354 - - *355 + - *356 + - *357 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -95071,9 +95623,9 @@ paths: application/json: schema: type: array - items: *493 + items: *495 examples: - default: *621 + default: *623 headers: Link: *70 '304': *37 @@ -95105,8 +95657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -95171,7 +95723,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &627 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -95326,7 +95878,7 @@ paths: items: *4 requested_teams: type: array - items: *346 + items: *348 head: type: object properties: @@ -95382,7 +95934,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: *622 + auto_merge: *624 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -95474,7 +96026,7 @@ paths: - merged_by - review_comments examples: - default: &626 + default: &628 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96001,8 +96553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: sort in: query required: false @@ -96031,9 +96583,9 @@ paths: application/json: schema: type: array - items: *623 + items: *625 examples: - default: &628 + default: &630 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -96110,17 +96662,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *623 + schema: *625 examples: - default: &624 + default: &626 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -96195,8 +96747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -96219,9 +96771,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: - default: *624 + default: *626 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96237,8 +96789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -96260,8 +96812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -96288,9 +96840,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -96311,8 +96863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -96345,16 +96897,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -96376,10 +96928,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - *562 + - *564 responses: '204': description: Response @@ -96422,9 +96974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *354 - - *355 - - &627 + - *356 + - *357 + - &629 name: pull_number description: The number that identifies the pull request. in: path @@ -96437,9 +96989,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *625 + schema: *627 examples: - default: *626 + default: *628 '304': *37 '404': *6 '406': @@ -96474,9 +97026,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -96518,9 +97070,9 @@ paths: description: Response content: application/json: - schema: *625 + schema: *627 examples: - default: *626 + default: *628 '422': *15 '403': *29 x-github: @@ -96542,9 +97094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -96606,7 +97158,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -96614,7 +97166,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -96644,9 +97196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -96667,9 +97219,9 @@ paths: application/json: schema: type: array - items: *623 + items: *625 examples: - default: *628 + default: *630 headers: Link: *70 x-github: @@ -96702,9 +97254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -96809,7 +97361,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: example-for-a-multi-line-comment: value: @@ -96897,9 +97449,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *104 requestBody: required: true @@ -96922,7 +97474,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: default: value: @@ -97008,9 +97560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -97020,9 +97572,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *629 + default: *631 headers: Link: *70 x-github: @@ -97052,9 +97604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -97064,7 +97616,7 @@ paths: application/json: schema: type: array - items: *502 + items: *504 examples: default: value: @@ -97102,9 +97654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 responses: '204': description: Response if pull request has been merged @@ -97127,9 +97679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -97240,9 +97792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 responses: '200': description: Response @@ -97317,9 +97869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -97356,7 +97908,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *495 examples: default: value: @@ -97892,9 +98444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -97928,7 +98480,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *495 examples: default: value: @@ -98433,9 +98985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -98445,7 +98997,7 @@ paths: application/json: schema: type: array - items: &630 + items: &632 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -98596,9 +99148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -98684,9 +99236,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: &632 + default: &634 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98749,10 +99301,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - &631 + - *356 + - *357 + - *629 + - &633 name: review_id description: The unique identifier of the review. in: path @@ -98764,9 +99316,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: &633 + default: &635 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98825,10 +99377,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -98851,7 +99403,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: default: value: @@ -98913,18 +99465,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 responses: '200': description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: *632 + default: *634 '422': *7 '404': *6 x-github: @@ -98951,10 +99503,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 - *17 - *19 responses: @@ -99189,10 +99741,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -99220,7 +99772,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: default: value: @@ -99283,10 +99835,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -99321,9 +99873,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: *633 + default: *635 '404': *6 '422': *7 '403': *29 @@ -99345,9 +99897,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -99410,8 +99962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -99424,9 +99976,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: &635 + default: &637 value: type: file encoding: base64 @@ -99468,8 +100020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *354 - - *355 + - *356 + - *357 - name: dir description: The alternate path to look for a README file in: path @@ -99489,9 +100041,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: *635 + default: *637 '404': *6 '422': *15 x-github: @@ -99513,8 +100065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -99524,7 +100076,7 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: default: value: @@ -99618,8 +100170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -99695,9 +100247,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: &640 + default: &642 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -99802,9 +100354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *354 - - *355 - - &638 + - *356 + - *357 + - &640 name: asset_id description: The unique identifier of the asset. in: path @@ -99816,9 +100368,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: &639 + default: &641 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -99853,7 +100405,7 @@ paths: type: User site_admin: false '404': *6 - '302': *506 + '302': *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99869,9 +100421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *354 - - *355 - - *638 + - *356 + - *357 + - *640 requestBody: required: false content: @@ -99899,9 +100451,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99917,9 +100469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *354 - - *355 - - *638 + - *356 + - *357 + - *640 responses: '204': description: Response @@ -99944,8 +100496,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -100030,16 +100582,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -100057,8 +100609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *354 - - *355 + - *356 + - *357 - name: tag description: tag parameter in: path @@ -100071,9 +100623,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -100095,9 +100647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *354 - - *355 - - &641 + - *356 + - *357 + - &643 name: release_id description: The unique identifier of the release. in: path @@ -100111,9 +100663,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '401': description: Unauthorized x-github: @@ -100131,9 +100683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 requestBody: required: false content: @@ -100197,9 +100749,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': description: Not Found if the discussion category name is invalid content: @@ -100220,9 +100772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 responses: '204': description: Response @@ -100243,9 +100795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - *17 - *19 responses: @@ -100255,7 +100807,7 @@ paths: application/json: schema: type: array - items: *637 + items: *639 examples: default: value: @@ -100336,9 +100888,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - name: name in: query required: true @@ -100364,7 +100916,7 @@ paths: description: Response for successful upload content: application/json: - schema: *637 + schema: *639 examples: response-for-successful-upload: value: @@ -100419,9 +100971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -100445,9 +100997,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -100468,9 +101020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 requestBody: required: true content: @@ -100500,16 +101052,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -100531,10 +101083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *354 - - *355 - - *641 - - *562 + - *356 + - *357 + - *643 + - *564 responses: '204': description: Response @@ -100558,9 +101110,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 - *17 - *19 responses: @@ -100577,7 +101129,7 @@ paths: oneOf: - allOf: - *318 - - &642 + - &644 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -100598,70 +101150,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *319 - - *642 + - *644 - allOf: - *320 - - *642 + - *644 - allOf: - *321 - - *642 + - *644 - allOf: - - *643 - - *642 + - *645 + - *644 - allOf: - *322 - - *642 + - *644 - allOf: - *323 - - *642 + - *644 - allOf: - *324 - - *642 + - *644 - allOf: - *325 - - *642 + - *644 - allOf: - *326 - - *642 + - *644 - allOf: - *327 - - *642 + - *644 - allOf: - *328 - - *642 + - *644 - allOf: - *329 - - *642 + - *644 - allOf: - *330 - - *642 + - *644 - allOf: - *331 - - *642 + - *644 - allOf: - *336 - - *642 + - *644 - allOf: - *337 - - *642 + - *644 - allOf: - *338 - - *642 + - *644 - allOf: + - *646 - *644 - - *642 - allOf: - *332 - - *642 + - *644 - allOf: - *333 - - *642 + - *644 - allOf: - *334 - - *642 + - *644 - allOf: - *335 - - *642 + - *644 examples: default: value: @@ -100700,8 +101252,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - name: includes_parents @@ -100712,7 +101264,7 @@ paths: schema: type: boolean default: true - - *645 + - *647 responses: '200': description: Response @@ -100767,8 +101319,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 requestBody: description: Request body required: true @@ -100797,7 +101349,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *646 + items: *648 required: - name - enforcement @@ -100830,7 +101382,7 @@ paths: application/json: schema: *339 examples: - default: &657 + default: &659 value: id: 42 name: super cool ruleset @@ -100878,13 +101430,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *354 - - *355 - - *647 - - *648 + - *356 + - *357 - *649 - *650 - *651 + - *652 + - *653 - *17 - *19 responses: @@ -100892,9 +101444,9 @@ paths: description: Response content: application/json: - schema: *652 + schema: *654 examples: - default: *653 + default: *655 '404': *6 '500': *55 x-github: @@ -100915,17 +101467,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *354 - - *355 - - *654 + - *356 + - *357 + - *656 responses: '200': description: Response content: application/json: - schema: *655 + schema: *657 examples: - default: *656 + default: *658 '404': *6 '500': *55 x-github: @@ -100953,8 +101505,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100976,7 +101528,7 @@ paths: application/json: schema: *339 examples: - default: *657 + default: *659 '404': *6 '500': *55 put: @@ -100994,8 +101546,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101029,7 +101581,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *646 + items: *648 examples: default: value: @@ -101059,7 +101611,7 @@ paths: application/json: schema: *339 examples: - default: *657 + default: *659 '404': *6 '422': *15 '500': *55 @@ -101078,8 +101630,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101102,8 +101654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - name: ruleset_id @@ -101121,7 +101673,7 @@ paths: type: array items: *342 examples: - default: *658 + default: *660 '404': *6 '500': *55 x-github: @@ -101140,8 +101692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101159,7 +101711,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: default: value: @@ -101214,21 +101766,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *354 - - *355 - - *660 - - *661 + - *356 + - *357 - *662 - *663 - *664 - *665 - *666 - *667 + - *668 + - *669 - *62 - *19 - *17 - - *668 - - *669 - *670 - *671 - *672 @@ -101236,6 +101786,8 @@ paths: - *674 - *675 - *676 + - *677 + - *678 responses: '200': description: Response @@ -101262,8 +101814,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolved_at: type: string format: date-time @@ -101369,7 +101921,7 @@ paths: pull request. ' - oneOf: *679 + oneOf: *681 nullable: true has_more_locations: type: boolean @@ -101533,16 +102085,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 - - *673 + - *356 + - *357 + - *455 + - *675 responses: '200': description: Response content: application/json: - schema: &680 + schema: &682 type: object properties: number: *188 @@ -101560,8 +102112,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolved_at: type: string format: date-time @@ -101667,7 +102219,7 @@ paths: pull request. ' - oneOf: *679 + oneOf: *681 nullable: true has_more_locations: type: boolean @@ -101695,7 +102247,7 @@ paths: properties: *20 required: *21 nullable: true - metadata: &839 + metadata: &854 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -101768,9 +102320,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: true content: @@ -101778,8 +102330,8 @@ paths: schema: type: object properties: - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -101823,7 +102375,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *682 examples: default: value: @@ -101925,9 +102477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 - *19 - *17 responses: @@ -101938,7 +102490,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &841 + items: &856 type: object properties: type: @@ -101964,8 +102516,6 @@ paths: example: commit details: oneOf: - - *681 - - *682 - *683 - *684 - *685 @@ -101977,6 +102527,8 @@ paths: - *691 - *692 - *693 + - *694 + - *695 examples: default: value: @@ -102046,6 +102598,221 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + - *696 + - *697 + - *698 + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *343 + examples: + default: *699 + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: *700 + examples: + default: *701 + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *343 + examples: + default: *702 + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: *703 + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: *704 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: *705 + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': *345 + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: *706 + examples: + default: *707 + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *343 + examples: + default: *708 + '400': *14 + '403': *29 + '404': *6 + '412': *345 + '422': *15 "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -102062,8 +102829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -102071,14 +102838,14 @@ paths: schema: type: object properties: - reason: &695 + reason: &710 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *694 + placeholder_id: *709 required: - reason - placeholder_id @@ -102095,7 +102862,7 @@ paths: schema: type: object properties: - reason: *695 + reason: *710 expire_at: type: string format: date-time @@ -102141,8 +102908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -102157,7 +102924,7 @@ paths: properties: incremental_scans: type: array - items: &696 + items: &711 description: Information on a single scan performed by secret scanning on the repository type: object @@ -102188,15 +102955,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *696 + items: *711 backfill_scans: type: array - items: *696 + items: *711 custom_pattern_backfill_scans: type: array items: allOf: - - *696 + - *711 - type: object properties: pattern_name: @@ -102209,7 +102976,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *696 + items: *711 examples: default: value: @@ -102274,8 +103041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *354 - - *355 + - *356 + - *357 - *62 - name: sort description: The property to sort the results by. @@ -102319,9 +103086,9 @@ paths: application/json: schema: type: array - items: *697 + items: *712 examples: - default: *698 + default: *713 '400': *14 '404': *6 x-github: @@ -102344,8 +103111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -102418,7 +103185,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 required: - login - type @@ -102505,9 +103272,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: &700 + default: &715 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -102740,8 +103507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -102845,7 +103612,7 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: default: value: @@ -102992,17 +103759,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '200': description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: *700 + default: *715 '403': *29 '404': *6 x-github: @@ -103026,9 +103793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 requestBody: required: true content: @@ -103101,7 +103868,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 required: - login - type @@ -103187,10 +103954,10 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: *700 - add_credit: *700 + default: *715 + add_credit: *715 '403': *29 '404': *6 '422': @@ -103228,9 +103995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '202': *39 '400': *14 @@ -103257,17 +104024,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '202': description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 '400': *14 '422': *15 '403': *29 @@ -103293,8 +104060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -103393,8 +104160,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -103403,7 +104170,7 @@ paths: application/json: schema: type: array - items: &701 + items: &716 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -103436,8 +104203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -103513,8 +104280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -103610,8 +104377,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -103765,8 +104532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -103776,7 +104543,7 @@ paths: application/json: schema: type: array - items: *701 + items: *716 examples: default: value: @@ -103809,8 +104576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *354 - - *355 + - *356 + - *357 - name: sha in: path required: true @@ -103864,7 +104631,7 @@ paths: description: Response content: application/json: - schema: *702 + schema: *717 examples: default: value: @@ -103918,8 +104685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -103951,14 +104718,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &703 + schema: &718 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104026,8 +104793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -104053,7 +104820,7 @@ paths: description: Response content: application/json: - schema: *703 + schema: *718 examples: default: value: @@ -104080,8 +104847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -104101,8 +104868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -104181,8 +104948,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *354 - - *355 + - *356 + - *357 - name: ref in: path required: true @@ -104218,8 +104985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -104251,8 +105018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 responses: @@ -104260,7 +105027,7 @@ paths: description: Response content: application/json: - schema: &704 + schema: &719 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -104272,7 +105039,7 @@ paths: required: - names examples: - default: &705 + default: &720 value: names: - octocat @@ -104295,8 +105062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -104327,9 +105094,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *719 examples: - default: *705 + default: *720 '404': *6 '422': *7 x-github: @@ -104350,9 +105117,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *354 - - *355 - - &706 + - *356 + - *357 + - &721 name: per description: The time frame to display results for. in: query @@ -104381,7 +105148,7 @@ paths: example: 128 clones: type: array - items: &707 + items: &722 title: Traffic type: object properties: @@ -104468,8 +105235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -104559,8 +105326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -104620,9 +105387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *354 - - *355 - - *706 + - *356 + - *357 + - *721 responses: '200': description: Response @@ -104641,7 +105408,7 @@ paths: example: 3782 views: type: array - items: *707 + items: *722 required: - uniques - count @@ -104718,8 +105485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -104993,8 +105760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -105017,8 +105784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -105040,8 +105807,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -105067,8 +105834,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *354 - - *355 + - *356 + - *357 - name: ref in: path required: true @@ -105160,9 +105927,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105413,7 +106180,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &708 + text_matches: &723 title: Search Result Text Matches type: array items: @@ -105575,7 +106342,7 @@ paths: enum: - author-date - committer-date - - &709 + - &724 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -105646,7 +106413,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true comment_count: type: integer @@ -105666,7 +106433,7 @@ paths: url: type: string format: uri - verification: *542 + verification: *544 required: - author - committer @@ -105685,7 +106452,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true parents: type: array @@ -105703,7 +106470,7 @@ paths: type: number node_id: type: string - text_matches: *708 + text_matches: *723 required: - sha - node_id @@ -105895,7 +106662,7 @@ paths: - interactions - created - updated - - *709 + - *724 - *17 - *19 - name: advanced_search @@ -106009,11 +106776,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: type: string state_reason: @@ -106045,7 +106812,7 @@ paths: type: string format: date-time nullable: true - text_matches: *708 + text_matches: *723 pull_request: type: object properties: @@ -106327,7 +107094,7 @@ paths: enum: - created - updated - - *709 + - *724 - *17 - *19 responses: @@ -106371,7 +107138,7 @@ paths: nullable: true score: type: number - text_matches: *708 + text_matches: *723 required: - id - node_id @@ -106456,7 +107223,7 @@ paths: - forks - help-wanted-issues - updated - - *709 + - *724 - *17 - *19 responses: @@ -106704,7 +107471,7 @@ paths: - admin - pull - push - text_matches: *708 + text_matches: *723 temp_clone_token: type: string allow_merge_commit: @@ -107004,7 +107771,7 @@ paths: type: string format: uri nullable: true - text_matches: *708 + text_matches: *723 related: type: array nullable: true @@ -107195,7 +107962,7 @@ paths: - followers - repositories - joined - - *709 + - *724 - *17 - *19 responses: @@ -107299,7 +108066,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *708 + text_matches: *723 blog: type: string nullable: true @@ -107378,7 +108145,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &712 + - &727 name: team_id description: The unique identifier of the team. in: path @@ -107390,9 +108157,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 x-github: githubCloudOnly: false @@ -107419,7 +108186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *712 + - *727 requestBody: required: true content: @@ -107482,16 +108249,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '201': description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 '422': *15 '403': *29 @@ -107519,7 +108286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *712 + - *727 responses: '204': description: Response @@ -107548,7 +108315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -107588,7 +108355,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *712 + - *727 - name: role description: Filters members returned by their role in the team. in: query @@ -107609,9 +108376,9 @@ paths: application/json: schema: type: array - items: *713 + items: *728 examples: - default: *714 + default: *729 headers: Link: *70 '404': *6 @@ -107639,7 +108406,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107676,7 +108443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107716,7 +108483,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107753,16 +108520,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 responses: '200': description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-user-is-a-team-maintainer: *715 + response-if-user-is-a-team-maintainer: *730 '404': *6 x-github: githubCloudOnly: false @@ -107795,7 +108562,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 requestBody: required: false @@ -107821,9 +108588,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: *716 + response-if-users-membership-with-team-is-now-pending: *731 '403': description: Forbidden if team synchronization is set up '422': @@ -107857,7 +108624,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107885,7 +108652,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -107927,15 +108694,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *717 + schema: *732 examples: alternative-response-with-extra-repository-information: value: @@ -108086,9 +108853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 requestBody: required: false content: @@ -108138,9 +108905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 responses: '204': description: Response @@ -108165,7 +108932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -108177,7 +108944,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *718 + response-if-child-teams-exist: *733 headers: Link: *70 '404': *6 @@ -108210,7 +108977,7 @@ paths: application/json: schema: oneOf: - - &720 + - &735 title: Private User description: Private User type: object @@ -108413,7 +109180,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *719 + - *734 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -108566,7 +109333,7 @@ paths: description: Response content: application/json: - schema: *720 + schema: *735 examples: default: value: @@ -108912,7 +109679,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -108920,7 +109687,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -108964,7 +109731,7 @@ paths: type: integer secrets: type: array - items: &721 + items: &736 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -109004,7 +109771,7 @@ paths: - visibility - selected_repositories_url examples: - default: *479 + default: *481 headers: Link: *70 x-github: @@ -109080,7 +109847,7 @@ paths: description: Response content: application/json: - schema: *721 + schema: *736 examples: default: value: @@ -109378,7 +110145,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '304': *37 '500': *55 '401': *25 @@ -109436,7 +110203,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -109493,7 +110260,7 @@ paths: description: Response content: application/json: - schema: &722 + schema: &737 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -109534,7 +110301,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &723 + default: &738 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -109579,9 +110346,9 @@ paths: description: Response content: application/json: - schema: *722 + schema: *737 examples: - default: *723 + default: *738 '404': *6 x-github: githubCloudOnly: false @@ -109618,9 +110385,9 @@ paths: type: integer machines: type: array - items: *724 + items: *739 examples: - default: *725 + default: *740 '304': *37 '500': *55 '401': *25 @@ -109699,13 +110466,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *357 + repository: *359 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *477 - required: *478 + properties: *479 + required: *480 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -110487,7 +111254,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '304': *37 '500': *55 '400': *14 @@ -110527,7 +111294,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '500': *55 '401': *25 '403': *29 @@ -110559,7 +111326,7 @@ paths: type: array items: *275 examples: - default: &737 + default: &752 value: - id: 197 name: hello_docker @@ -110660,7 +111427,7 @@ paths: application/json: schema: type: array - items: &726 + items: &741 title: Email description: Email type: object @@ -110725,9 +111492,9 @@ paths: application/json: schema: type: array - items: *726 + items: *741 examples: - default: &739 + default: &754 value: - email: octocat@github.com verified: true @@ -110802,7 +111569,7 @@ paths: application/json: schema: type: array - items: *726 + items: *741 examples: default: value: @@ -111058,7 +111825,7 @@ paths: application/json: schema: type: array - items: &727 + items: &742 title: GPG Key description: A unique encryption key type: object @@ -111189,7 +111956,7 @@ paths: - subkeys - revoked examples: - default: &756 + default: &771 value: - id: 3 name: Octocat's GPG Key @@ -111274,9 +112041,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *742 examples: - default: &728 + default: &743 value: id: 3 name: Octocat's GPG Key @@ -111333,7 +112100,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &729 + - &744 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -111345,9 +112112,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *742 examples: - default: *728 + default: *743 '404': *6 '304': *37 '403': *29 @@ -111370,7 +112137,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *729 + - *744 responses: '204': description: Response @@ -111687,7 +112454,7 @@ paths: required: true content: application/json: - schema: *553 + schema: *555 examples: default: value: @@ -111837,7 +112604,7 @@ paths: application/json: schema: type: array - items: &730 + items: &745 title: Key description: Key type: object @@ -111938,9 +112705,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *745 examples: - default: &731 + default: &746 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -111973,15 +112740,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *606 + - *608 responses: '200': description: Response content: application/json: - schema: *730 + schema: *745 examples: - default: *731 + default: *746 '404': *6 '304': *37 '403': *29 @@ -112004,7 +112771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *606 + - *608 responses: '204': description: Response @@ -112037,7 +112804,7 @@ paths: application/json: schema: type: array - items: &732 + items: &747 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -112105,7 +112872,7 @@ paths: - account - plan examples: - default: &733 + default: &748 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -112167,9 +112934,9 @@ paths: application/json: schema: type: array - items: *732 + items: *747 examples: - default: *733 + default: *748 headers: Link: *70 '304': *37 @@ -112412,7 +113179,7 @@ paths: application/json: schema: *266 examples: - default: &734 + default: &749 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -112461,7 +113228,7 @@ paths: application/json: schema: *266 examples: - default: *734 + default: *749 '403': *29 '404': *6 '422': *15 @@ -113186,7 +113953,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *269 - - *735 + - *750 responses: '204': description: Response @@ -113301,7 +114068,7 @@ paths: - docker - nuget - container - - *736 + - *751 - *19 - *17 responses: @@ -113313,8 +114080,8 @@ paths: type: array items: *275 examples: - default: *737 - '400': *738 + default: *752 + '400': *753 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113343,7 +114110,7 @@ paths: application/json: schema: *275 examples: - default: &757 + default: &772 value: id: 40201 name: octo-name @@ -113705,9 +114472,9 @@ paths: application/json: schema: type: array - items: *726 + items: *741 examples: - default: *739 + default: *754 headers: Link: *70 '304': *37 @@ -113820,7 +114587,7 @@ paths: type: array items: *82 examples: - default: &746 + default: &761 summary: Default response value: - id: 1296269 @@ -114124,9 +114891,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -114164,9 +114931,9 @@ paths: application/json: schema: type: array - items: *556 + items: *558 examples: - default: *740 + default: *755 headers: Link: *70 '304': *37 @@ -114245,7 +115012,7 @@ paths: application/json: schema: type: array - items: &741 + items: &756 title: Social account description: Social media account type: object @@ -114260,7 +115027,7 @@ paths: - provider - url examples: - default: &742 + default: &757 value: - provider: twitter url: https://twitter.com/github @@ -114322,9 +115089,9 @@ paths: application/json: schema: type: array - items: *741 + items: *756 examples: - default: *742 + default: *757 '422': *15 '304': *37 '404': *6 @@ -114411,7 +115178,7 @@ paths: application/json: schema: type: array - items: &743 + items: &758 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -114431,7 +115198,7 @@ paths: - title - created_at examples: - default: &774 + default: &789 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114495,9 +115262,9 @@ paths: description: Response content: application/json: - schema: *743 + schema: *758 examples: - default: &744 + default: &759 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114527,7 +115294,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &745 + - &760 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -114539,9 +115306,9 @@ paths: description: Response content: application/json: - schema: *743 + schema: *758 examples: - default: *744 + default: *759 '404': *6 '304': *37 '403': *29 @@ -114564,7 +115331,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *745 + - *760 responses: '204': description: Response @@ -114593,7 +115360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &775 + - &790 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -114618,11 +115385,11 @@ paths: type: array items: *82 examples: - default-response: *746 + default-response: *761 application/vnd.github.v3.star+json: schema: type: array - items: &776 + items: &791 title: Starred Repository description: Starred Repository type: object @@ -114778,8 +115545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response if this repository is starred by you @@ -114807,8 +115574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -114832,8 +115599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -114905,7 +115672,7 @@ paths: application/json: schema: type: array - items: *350 + items: *352 examples: default: value: @@ -114991,10 +115758,10 @@ paths: application/json: schema: oneOf: - - *720 - - *719 + - *735 + - *734 examples: - default-response: &750 + default-response: &765 summary: Default response value: login: octocat @@ -115029,7 +115796,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &751 + response-with-git-hub-plan-information: &766 summary: Response with GitHub plan information value: login: octocat @@ -115086,7 +115853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &748 + - &763 name: user_id description: The unique identifier of the user. in: path @@ -115152,7 +115919,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *747 + - *762 - *17 responses: '200': @@ -115187,7 +115954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *748 + - *763 - *293 requestBody: required: true @@ -115259,7 +116026,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *749 + schema: *764 examples: table_view: summary: Response for creating a table view @@ -115311,11 +116078,11 @@ paths: application/json: schema: oneOf: - - *720 - - *719 + - *735 + - *734 examples: - default-response: *750 - response-with-git-hub-plan-information: *751 + default-response: *765 + response-with-git-hub-plan-information: *766 '404': *6 x-github: githubCloudOnly: false @@ -115365,8 +116132,8 @@ paths: required: - subject_digests examples: - default: *752 - withPredicateType: *753 + default: *767 + withPredicateType: *768 responses: '200': description: Response @@ -115419,7 +116186,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *754 + default: *769 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -115624,7 +116391,7 @@ paths: initiator: type: string examples: - default: *414 + default: *416 '201': description: Response content: @@ -115905,7 +116672,7 @@ paths: application/json: schema: *204 examples: - default: &755 + default: &770 summary: Example response for a user copilot space value: id: 42 @@ -116006,7 +116773,7 @@ paths: application/json: schema: *204 examples: - default: *755 + default: *770 '403': *29 '404': *6 x-github: @@ -116129,7 +116896,7 @@ paths: application/json: schema: *204 examples: - default: *755 + default: *770 '403': *29 '404': *6 '422': *15 @@ -116897,7 +117664,7 @@ paths: type: array items: *275 examples: - default: *737 + default: *752 '403': *29 '401': *25 x-github: @@ -117281,9 +118048,9 @@ paths: application/json: schema: type: array - items: *727 + items: *742 examples: - default: *756 + default: *771 headers: Link: *70 x-github: @@ -117387,7 +118154,7 @@ paths: application/json: schema: *22 examples: - default: *552 + default: *554 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117511,7 +118278,7 @@ paths: - docker - nuget - container - - *736 + - *751 - *74 - *19 - *17 @@ -117524,10 +118291,10 @@ paths: type: array items: *275 examples: - default: *737 + default: *752 '403': *29 '401': *25 - '400': *738 + '400': *753 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117557,7 +118324,7 @@ paths: application/json: schema: *275 examples: - default: *757 + default: *772 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117906,7 +118673,7 @@ paths: type: array items: *297 examples: - default: *758 + default: *773 headers: Link: *70 '304': *37 @@ -117966,7 +118733,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *759 + items: *774 required: - name - data_type @@ -117982,7 +118749,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *760 + iteration_configuration: *775 required: - name - data_type @@ -118004,8 +118771,8 @@ paths: value: name: Due date data_type: date - single_select_field: *761 - iteration_field: *762 + single_select_field: *776 + iteration_field: *777 responses: '201': description: Response @@ -118013,11 +118780,11 @@ paths: application/json: schema: *297 examples: - text_field: *763 - number_field: *764 - date_field: *765 - single_select_field: *766 - iteration_field: *767 + text_field: *778 + number_field: *779 + date_field: *780 + single_select_field: *781 + iteration_field: *782 '304': *37 '403': *29 '401': *25 @@ -118039,7 +118806,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *293 - - *768 + - *783 - *74 responses: '200': @@ -118048,7 +118815,7 @@ paths: application/json: schema: *297 examples: - default: *769 + default: *784 headers: Link: *70 '304': *37 @@ -118402,7 +119169,7 @@ paths: parameters: - *293 - *74 - - *770 + - *785 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -118941,7 +119708,7 @@ paths: parameters: - *74 - *124 - - *771 + - *786 - *126 responses: '200': @@ -119040,9 +119807,9 @@ paths: - *124 - *125 - *126 - - *772 + - *787 - *129 - - *773 + - *788 responses: '200': description: Response when getting a billing usage summary @@ -119176,9 +119943,9 @@ paths: application/json: schema: type: array - items: *741 + items: *756 examples: - default: *742 + default: *757 headers: Link: *70 x-github: @@ -119208,9 +119975,9 @@ paths: application/json: schema: type: array - items: *743 + items: *758 examples: - default: *774 + default: *789 headers: Link: *70 x-github: @@ -119235,7 +120002,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *775 + - *790 - *62 - *17 - *19 @@ -119247,11 +120014,11 @@ paths: schema: anyOf: - type: array - items: *776 + items: *791 - type: array items: *82 examples: - default-response: *746 + default-response: *761 headers: Link: *70 x-github: @@ -119410,7 +120177,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &777 + enterprise: &792 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -119468,7 +120235,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &778 + installation: &793 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -119487,7 +120254,7 @@ x-webhooks: required: - id - node_id - organization: &779 + organization: &794 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -119547,13 +120314,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &780 + repository: &795 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &812 + properties: &827 id: description: Unique identifier of the repository example: 42 @@ -120248,7 +121015,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &813 + required: &828 - archive_url - assignees_url - blobs_url @@ -120399,10 +121166,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -120478,11 +121245,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: &781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: &796 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -120705,11 +121472,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: *781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: *796 sender: *4 required: - action @@ -120892,11 +121659,11 @@ x-webhooks: - everyone required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: *781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: *796 sender: *4 required: - action @@ -120980,7 +121747,7 @@ x-webhooks: type: string enum: - completed - check_run: &783 + check_run: &798 title: CheckRun description: A check performed on the code of a given code change type: object @@ -121071,7 +121838,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *782 + deployment: *797 details_url: example: https://example.com type: string @@ -121156,10 +121923,10 @@ x-webhooks: - output - app - pull_requests - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -121550,11 +122317,11 @@ x-webhooks: type: string enum: - created - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -121948,11 +122715,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 requested_action: description: The action requested by the user. type: object @@ -122355,11 +123122,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -123329,10 +124096,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -124031,10 +124798,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -124727,10 +125494,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -124896,7 +125663,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -125041,20 +125808,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &784 + commit_oid: &799 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *777 - installation: *778 - organization: *779 - ref: &785 + enterprise: *792 + installation: *793 + organization: *794 + ref: &800 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -125219,7 +125986,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -125449,12 +126216,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -125549,7 +126316,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -125720,12 +126487,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -125891,7 +126658,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126057,12 +126824,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -126161,7 +126928,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -126336,16 +127103,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *780 + repository: *795 sender: *4 required: - action @@ -126442,7 +127209,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -126582,12 +127349,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -126753,7 +127520,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126898,10 +127665,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -127156,10 +127923,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -127239,18 +128006,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *779 - pusher_type: &786 + organization: *794 + pusher_type: &801 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &787 + ref: &802 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -127260,7 +128027,7 @@ x-webhooks: enum: - tag - branch - repository: *780 + repository: *795 sender: *4 required: - ref @@ -127343,9 +128110,9 @@ x-webhooks: enum: - created definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127430,9 +128197,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127510,9 +128277,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127590,9 +128357,9 @@ x-webhooks: enum: - updated definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127669,10 +128436,10 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - repository: *780 - organization: *779 + enterprise: *792 + installation: *793 + repository: *795 + organization: *794 sender: *4 new_property_values: type: array @@ -127757,18 +128524,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - pusher_type: *786 - ref: *787 + enterprise: *792 + installation: *793 + organization: *794 + pusher_type: *801 + ref: *802 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *780 + repository: *795 sender: *4 required: - ref @@ -127848,11 +128615,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127932,11 +128699,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128017,11 +128784,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128102,11 +128869,11 @@ x-webhooks: type: string enum: - created - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128185,11 +128952,11 @@ x-webhooks: type: string enum: - dismissed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128268,11 +129035,11 @@ x-webhooks: type: string enum: - fixed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128352,11 +129119,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128435,11 +129202,11 @@ x-webhooks: type: string enum: - reopened - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128516,9 +129283,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - key: &788 + enterprise: *792 + installation: *793 + key: &803 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -128554,8 +129321,8 @@ x-webhooks: - verified - created_at - read_only - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -128632,11 +129399,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - key: *788 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + key: *803 + organization: *794 + repository: *795 sender: *4 required: - action @@ -129192,12 +129959,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: &794 + workflow: &809 title: Workflow type: object nullable: true @@ -129938,15 +130705,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *789 - required: *790 + properties: *804 + required: *805 nullable: true pull_requests: type: array - items: *625 - repository: *780 - organization: *779 - installation: *778 + items: *627 + repository: *795 + organization: *794 + installation: *793 sender: *4 responses: '200': @@ -130017,7 +130784,7 @@ x-webhooks: type: string enum: - approved - approver: &791 + approver: &806 type: object properties: avatar_url: @@ -130060,11 +130827,11 @@ x-webhooks: type: string comment: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - reviewers: &792 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + reviewers: &807 type: array items: type: object @@ -130143,7 +130910,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &793 + workflow_job_run: &808 type: object properties: conclusion: @@ -130874,18 +131641,18 @@ x-webhooks: type: string enum: - rejected - approver: *791 + approver: *806 comment: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - reviewers: *792 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + reviewers: *807 sender: *4 since: type: string - workflow_job_run: *793 + workflow_job_run: *808 workflow_job_runs: type: array items: @@ -131589,13 +132356,13 @@ x-webhooks: type: string enum: - requested - enterprise: *777 + enterprise: *792 environment: type: string - installation: *778 - organization: *779 - repository: *780 - requestor: &799 + installation: *793 + organization: *794 + repository: *795 + requestor: &814 title: User type: object nullable: true @@ -133484,12 +134251,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Deployment Workflow Run type: object @@ -134169,7 +134936,7 @@ x-webhooks: type: string enum: - answered - answer: &797 + answer: &812 type: object properties: author_association: @@ -134326,11 +135093,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134457,11 +135224,11 @@ x-webhooks: - from required: - category - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134544,11 +135311,11 @@ x-webhooks: type: string enum: - closed - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134630,7 +135397,7 @@ x-webhooks: type: string enum: - created - comment: &796 + comment: &811 type: object properties: author_association: @@ -134787,11 +135554,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134874,12 +135641,12 @@ x-webhooks: type: string enum: - deleted - comment: *796 - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + comment: *811 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134974,12 +135741,12 @@ x-webhooks: - from required: - body - comment: *796 - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + comment: *811 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135063,11 +135830,11 @@ x-webhooks: type: string enum: - created - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135149,11 +135916,11 @@ x-webhooks: type: string enum: - deleted - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135253,11 +136020,11 @@ x-webhooks: type: string required: - from - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135339,10 +136106,10 @@ x-webhooks: type: string enum: - labeled - discussion: *795 - enterprise: *777 - installation: *778 - label: &798 + discussion: *810 + enterprise: *792 + installation: *793 + label: &813 title: Label type: object properties: @@ -135374,8 +136141,8 @@ x-webhooks: - color - default - description - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135458,11 +136225,11 @@ x-webhooks: type: string enum: - locked - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135544,11 +136311,11 @@ x-webhooks: type: string enum: - pinned - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135630,11 +136397,11 @@ x-webhooks: type: string enum: - reopened - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135719,16 +136486,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *795 - new_repository: *780 + new_discussion: *810 + new_repository: *795 required: - new_discussion - new_repository - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135811,10 +136578,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *795 - old_answer: *797 - organization: *779 - repository: *780 + discussion: *810 + old_answer: *812 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135896,12 +136663,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *795 - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135984,11 +136751,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -136070,11 +136837,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -136147,7 +136914,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *777 + enterprise: *792 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -136807,9 +137574,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - forkee @@ -136955,9 +137722,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pages: description: The pages that were updated. type: array @@ -136994,7 +137761,7 @@ x-webhooks: - action - sha - html_url - repository: *780 + repository: *795 sender: *4 required: - pages @@ -137070,10 +137837,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: &800 + organization: *794 + repositories: &815 description: An array of repository objects that the installation can access. type: array @@ -137099,8 +137866,8 @@ x-webhooks: - name - full_name - private - repository: *780 - requester: *799 + repository: *795 + requester: *814 sender: *4 required: - action @@ -137175,11 +137942,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -137255,11 +138022,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -137335,10 +138102,10 @@ x-webhooks: type: string enum: - added - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories_added: &801 + organization: *794 + repositories_added: &816 description: An array of repository objects, which were added to the installation. type: array @@ -137384,15 +138151,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *780 - repository_selection: &802 + repository: *795 + repository_selection: &817 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *799 + requester: *814 sender: *4 required: - action @@ -137471,10 +138238,10 @@ x-webhooks: type: string enum: - removed - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories_added: *801 + organization: *794 + repositories_added: *816 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -137501,9 +138268,9 @@ x-webhooks: - name - full_name - private - repository: *780 - repository_selection: *802 - requester: *799 + repository: *795 + repository_selection: *817 + requester: *814 sender: *4 required: - action @@ -137582,11 +138349,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -137764,10 +138531,10 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 target_type: type: string @@ -137846,11 +138613,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -138024,15 +138791,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true user: title: User @@ -138117,8 +138884,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138907,8 +139674,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139257,8 +140024,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -139338,7 +140105,7 @@ x-webhooks: type: string enum: - deleted - comment: &803 + comment: &818 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -139495,15 +140262,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true required: - url @@ -139518,8 +140285,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -140304,8 +141071,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140656,8 +141423,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -140737,7 +141504,7 @@ x-webhooks: type: string enum: - edited - changes: &832 + changes: &847 description: The changes to the comment. type: object properties: @@ -140749,9 +141516,9 @@ x-webhooks: type: string required: - from - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141539,8 +142306,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141889,8 +142656,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -141971,9 +142738,9 @@ x-webhooks: type: string enum: - pinned - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142763,8 +143530,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143115,8 +143882,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -143196,9 +143963,9 @@ x-webhooks: type: string enum: - unpinned - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143988,8 +144755,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144340,8 +145107,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144430,9 +145197,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144521,9 +145288,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144611,9 +145378,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144702,9 +145469,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144784,10 +145551,10 @@ x-webhooks: type: string enum: - assigned - assignee: *799 - enterprise: *777 - installation: *778 - issue: &804 + assignee: *814 + enterprise: *792 + installation: *793 + issue: &819 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145579,11 +146346,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145700,8 +146467,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -145781,8 +146548,8 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146579,11 +147346,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146835,8 +147602,8 @@ x-webhooks: required: - state - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -146915,8 +147682,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147704,11 +148471,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147824,8 +148591,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -147904,8 +148671,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148715,11 +149482,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148814,7 +149581,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &805 + milestone: &820 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148952,8 +149719,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -149052,8 +149819,8 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149845,11 +150612,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149966,9 +150733,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *798 - organization: *779 - repository: *780 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -150048,9 +150815,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 issue_field: type: object description: The issue field whose value was set or updated on the @@ -150204,8 +150971,8 @@ x-webhooks: - id required: - from - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -150285,9 +151052,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -150368,8 +151135,8 @@ x-webhooks: nullable: true required: - id - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -150449,8 +151216,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151241,11 +152008,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151362,9 +152129,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *798 - organization: *779 - repository: *780 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -151444,8 +152211,8 @@ x-webhooks: type: string enum: - locked - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152260,11 +153027,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152358,8 +153125,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -152438,8 +153205,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153248,11 +154015,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153346,9 +154113,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *805 - organization: *779 - repository: *780 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -154211,11 +154978,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154796,8 +155563,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155581,11 +156348,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155709,8 +156476,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -155790,9 +156557,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *777 - installation: *778 - issue: &806 + enterprise: *792 + installation: *793 + issue: &821 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -156578,11 +157345,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156698,8 +157465,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -156778,8 +157545,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -157592,11 +158359,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157691,8 +158458,8 @@ x-webhooks: user_view_type: type: string type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -158561,11 +159328,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159160,11 +159927,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *777 - installation: *778 - issue: *806 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *821 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159244,12 +160011,12 @@ x-webhooks: type: string enum: - typed - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159330,7 +160097,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &835 + assignee: &850 title: User type: object nullable: true @@ -159400,11 +160167,11 @@ x-webhooks: required: - login - id - enterprise: *777 - installation: *778 - issue: *804 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *819 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159483,12 +160250,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *777 - installation: *778 - issue: *804 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *819 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159568,8 +160335,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160382,11 +161149,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160480,8 +161247,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160561,11 +161328,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *777 - installation: *778 - issue: *806 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *821 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160644,12 +161411,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160729,11 +161496,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160811,11 +161578,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160925,11 +161692,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -161011,9 +161778,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: &807 + enterprise: *792 + installation: *793 + marketplace_purchase: &822 title: Marketplace Purchase type: object required: @@ -161096,8 +161863,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *779 - previous_marketplace_purchase: &808 + organization: *794 + previous_marketplace_purchase: &823 title: Marketplace Purchase type: object properties: @@ -161177,7 +161944,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -161257,10 +162024,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161343,7 +162110,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -161425,10 +162192,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161510,7 +162277,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -161591,8 +162358,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 marketplace_purchase: title: Marketplace Purchase type: object @@ -161674,9 +162441,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *779 - previous_marketplace_purchase: *808 - repository: *780 + organization: *794 + previous_marketplace_purchase: *823 + repository: *795 sender: *4 required: - action @@ -161756,12 +162523,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 - previous_marketplace_purchase: *808 - repository: *780 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 + previous_marketplace_purchase: *823 + repository: *795 sender: *4 required: - action @@ -161863,11 +162630,11 @@ x-webhooks: type: string required: - to - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -161967,11 +162734,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162050,11 +162817,11 @@ x-webhooks: type: string enum: - removed - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162132,11 +162899,11 @@ x-webhooks: type: string enum: - added - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162212,7 +162979,7 @@ x-webhooks: required: - login - id - team: &809 + team: &824 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162435,11 +163202,11 @@ x-webhooks: type: string enum: - removed - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162516,7 +163283,7 @@ x-webhooks: required: - login - id - team: *809 + team: *824 required: - action - scope @@ -162598,8 +163365,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *778 - merge_group: &811 + installation: *793 + merge_group: &826 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162618,15 +163385,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *810 + head_commit: *825 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162712,10 +163479,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *778 - merge_group: *811 - organization: *779 - repository: *780 + installation: *793 + merge_group: *826 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162788,7 +163555,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 + enterprise: *792 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -162897,16 +163664,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *778 - organization: *779 + installation: *793 + organization: *794 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -162987,11 +163754,11 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163070,9 +163837,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - milestone: &814 + enterprise: *792 + installation: *793 + milestone: &829 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163209,8 +163976,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163289,11 +164056,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163403,11 +164170,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163487,11 +164254,11 @@ x-webhooks: type: string enum: - opened - enterprise: *777 - installation: *778 - milestone: *814 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *829 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163570,11 +164337,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *799 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + blocked_user: *814 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163653,11 +164420,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *799 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + blocked_user: *814 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163736,9 +164503,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - membership: &815 + enterprise: *792 + installation: *793 + membership: &830 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -163845,8 +164612,8 @@ x-webhooks: - role - organization_url - user - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163924,11 +164691,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -164007,8 +164774,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164124,10 +164891,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 - user: *799 + user: *814 required: - action - invitation @@ -164205,11 +164972,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -164296,11 +165063,11 @@ x-webhooks: properties: from: type: string - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -164377,9 +165144,9 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 package: description: Information about the package. type: object @@ -164878,7 +165645,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &816 + items: &831 title: Ruby Gems metadata type: object properties: @@ -164973,7 +165740,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -165049,9 +165816,9 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 package: description: Information about the package. type: object @@ -165404,7 +166171,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *816 + items: *831 source_url: type: string format: uri @@ -165474,7 +166241,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -165650,12 +166417,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *777 + enterprise: *792 id: type: integer - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - id @@ -165732,7 +166499,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &817 + personal_access_token_request: &832 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -165878,10 +166645,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *777 - organization: *779 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -165958,11 +166725,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *817 - enterprise: *777 - organization: *779 + personal_access_token_request: *832 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -166038,11 +166805,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *817 - enterprise: *777 - organization: *779 + personal_access_token_request: *832 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -166117,11 +166884,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *817 - organization: *779 - enterprise: *777 + personal_access_token_request: *832 + organization: *794 + enterprise: *792 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -166226,7 +166993,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *818 + last_response: *833 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166258,8 +167025,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 zen: description: Random string of GitHub zen. @@ -166504,10 +167271,10 @@ x-webhooks: - from required: - note - enterprise: *777 - installation: *778 - organization: *779 - project_card: &819 + enterprise: *792 + installation: *793 + organization: *794 + project_card: &834 title: Project Card type: object properties: @@ -166626,7 +167393,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -166707,11 +167474,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project_card: *819 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_card: *834 + repository: *795 sender: *4 required: - action @@ -166791,9 +167558,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 project_card: title: Project Card type: object @@ -166921,8 +167688,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -167016,11 +167783,11 @@ x-webhooks: - from required: - note - enterprise: *777 - installation: *778 - organization: *779 - project_card: *819 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_card: *834 + repository: *795 sender: *4 required: - action @@ -167114,9 +167881,9 @@ x-webhooks: - from required: - column_id - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 project_card: allOf: - title: Project Card @@ -167306,7 +168073,7 @@ x-webhooks: type: string required: - after_id - repository: *780 + repository: *795 sender: *4 required: - action @@ -167386,10 +168153,10 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - organization: *779 - project: &821 + enterprise: *792 + installation: *793 + organization: *794 + project: &836 title: Project type: object properties: @@ -167513,7 +168280,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -167593,10 +168360,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project_column: &820 + enterprise: *792 + installation: *793 + organization: *794 + project_column: &835 title: Project Column type: object properties: @@ -167635,7 +168402,7 @@ x-webhooks: - name - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -167714,18 +168481,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -167815,11 +168582,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 + repository: *795 sender: *4 required: - action @@ -167899,11 +168666,11 @@ x-webhooks: type: string enum: - moved - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 + repository: *795 sender: *4 required: - action @@ -167983,11 +168750,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -168067,18 +168834,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - project: *821 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -168180,11 +168947,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -168263,11 +169030,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -168348,8 +169115,8 @@ x-webhooks: type: string enum: - closed - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168431,8 +169198,8 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168514,8 +169281,8 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168633,8 +169400,8 @@ x-webhooks: type: string to: type: string - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168718,7 +169485,7 @@ x-webhooks: type: string enum: - archived - changes: &825 + changes: &840 type: object properties: archived_at: @@ -168732,9 +169499,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *778 - organization: *779 - projects_v2_item: &822 + installation: *793 + organization: *794 + projects_v2_item: &837 title: Projects v2 Item description: An item belonging to a project type: object @@ -168869,9 +169636,9 @@ x-webhooks: nullable: true to: type: string - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168953,9 +169720,9 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169036,9 +169803,9 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169144,7 +169911,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &823 + - &838 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169166,7 +169933,7 @@ x-webhooks: required: - id - name - - &824 + - &839 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169200,8 +169967,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *823 - - *824 + - *838 + - *839 required: - field_value - type: object @@ -169217,9 +169984,9 @@ x-webhooks: nullable: true required: - body - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169314,9 +170081,9 @@ x-webhooks: to: type: string nullable: true - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169399,10 +170166,10 @@ x-webhooks: type: string enum: - restored - changes: *825 - installation: *778 - organization: *779 - projects_v2_item: *822 + changes: *840 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169484,8 +170251,8 @@ x-webhooks: type: string enum: - reopened - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -169567,14 +170334,14 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 - projects_v2_status_update: &828 + installation: *793 + organization: *794 + projects_v2_status_update: &843 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *826 - required: *827 + properties: *841 + required: *842 sender: *4 required: - action @@ -169655,9 +170422,9 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 - projects_v2_status_update: *828 + installation: *793 + organization: *794 + projects_v2_status_update: *843 sender: *4 required: - action @@ -169793,9 +170560,9 @@ x-webhooks: type: string format: date nullable: true - installation: *778 - organization: *779 - projects_v2_status_update: *828 + installation: *793 + organization: *794 + projects_v2_status_update: *843 sender: *4 required: - action @@ -169866,10 +170633,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - repository @@ -169946,13 +170713,13 @@ x-webhooks: type: string enum: - assigned - assignee: *799 - enterprise: *777 - installation: *778 - number: &829 + assignee: *814 + enterprise: *792 + installation: *793 + number: &844 description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -172257,7 +173024,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -172339,11 +173106,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -174643,7 +175410,7 @@ x-webhooks: - draft reason: type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -174725,11 +175492,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -177029,7 +177796,7 @@ x-webhooks: - draft reason: type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -177111,13 +177878,13 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: &830 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: &845 allOf: - - *625 + - *627 - type: object properties: allow_auto_merge: @@ -177179,7 +177946,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *780 + repository: *795 sender: *4 required: - action @@ -177260,12 +178027,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -177345,11 +178112,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *777 - milestone: *609 - number: *829 - organization: *779 - pull_request: &831 + enterprise: *792 + milestone: *611 + number: *844 + organization: *794 + pull_request: &846 title: Pull Request type: object properties: @@ -179634,7 +180401,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -179713,11 +180480,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -182021,7 +182788,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *780 + repository: *795 sender: *4 required: - action @@ -182145,12 +182912,12 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -182230,11 +182997,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -184523,7 +185290,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -184603,11 +185370,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *777 - installation: *778 - label: *798 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + label: *813 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -186911,7 +187678,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -186992,10 +187759,10 @@ x-webhooks: type: string enum: - locked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -189297,7 +190064,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -189377,12 +190144,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *777 - milestone: *609 - number: *829 - organization: *779 - pull_request: *831 - repository: *780 + enterprise: *792 + milestone: *611 + number: *844 + organization: *794 + pull_request: *846 + repository: *795 sender: *4 required: - action @@ -189461,12 +190228,12 @@ x-webhooks: type: string enum: - opened - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -189547,12 +190314,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -189632,12 +190399,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -190003,9 +190770,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -192197,7 +192964,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -192277,7 +193044,7 @@ x-webhooks: type: string enum: - deleted - comment: &833 + comment: &848 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192562,9 +193329,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -194744,7 +195511,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -194824,11 +195591,11 @@ x-webhooks: type: string enum: - edited - changes: *832 - comment: *833 - enterprise: *777 - installation: *778 - organization: *779 + changes: *847 + comment: *848 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -197011,7 +197778,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -197092,9 +197859,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -199289,7 +200056,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 review: description: The review that was affected. type: object @@ -199536,9 +200303,9 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -201592,8 +202359,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 - review: &834 + repository: *795 + review: &849 description: The review that was affected. type: object properties: @@ -201826,12 +202593,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -204136,7 +204903,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_reviewer: title: User type: object @@ -204220,12 +204987,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -206537,7 +207304,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_team: title: Team description: Groups of organization members that gives permissions @@ -206729,12 +207496,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -209041,7 +209808,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_reviewer: title: User type: object @@ -209126,12 +209893,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -211429,7 +212196,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211610,9 +212377,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -213809,8 +214576,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 - review: *834 + repository: *795 + review: *849 sender: *4 required: - action @@ -213890,9 +214657,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -215984,7 +216751,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 sender: *4 thread: type: object @@ -216371,9 +217138,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -218451,7 +219218,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 sender: *4 thread: type: object @@ -218835,10 +219602,10 @@ x-webhooks: type: string enum: - stacked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -221142,7 +221909,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -221228,10 +221995,10 @@ x-webhooks: type: string before: type: string - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -223524,7 +224291,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -223606,11 +224373,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *835 - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + assignee: *850 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -225915,7 +226682,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -225994,11 +226761,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *777 - installation: *778 - label: *798 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + label: *813 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -228293,7 +229060,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -228374,10 +229141,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -230664,7 +231431,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -230864,7 +231631,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *777 + enterprise: *792 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -230956,8 +231723,8 @@ x-webhooks: - url - author - committer - installation: *778 - organization: *779 + installation: *793 + organization: *794 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -231543,9 +232310,9 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 registry_package: type: object properties: @@ -231991,7 +232758,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *816 + items: *831 summary: type: string tag_name: @@ -232045,7 +232812,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -232123,9 +232890,9 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 registry_package: type: object properties: @@ -232433,7 +233200,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *816 + items: *831 summary: type: string tag_name: @@ -232482,7 +233249,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -232559,10 +233326,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - release: &836 + enterprise: *792 + installation: *793 + organization: *794 + release: &851 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -232880,7 +233647,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *780 + repository: *795 sender: *4 required: - action @@ -232957,11 +233724,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -233078,11 +233845,11 @@ x-webhooks: type: boolean required: - to - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -233160,9 +233927,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -233484,7 +234251,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *780 + repository: *795 sender: *4 required: - action @@ -233560,10 +234327,10 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - release: &837 + enterprise: *792 + installation: *793 + organization: *794 + release: &852 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -233882,7 +234649,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *780 + repository: *795 sender: *4 required: - action @@ -233958,11 +234725,11 @@ x-webhooks: type: string enum: - released - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -234038,11 +234805,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *777 - installation: *778 - organization: *779 - release: *837 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *852 + repository: *795 sender: *4 required: - action @@ -234118,11 +234885,11 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - repository_advisory: *697 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + repository_advisory: *712 sender: *4 required: - action @@ -234198,11 +234965,11 @@ x-webhooks: type: string enum: - reported - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - repository_advisory: *697 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + repository_advisory: *712 sender: *4 required: - action @@ -234278,10 +235045,10 @@ x-webhooks: type: string enum: - archived - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234358,10 +235125,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234439,10 +235206,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234526,10 +235293,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234641,10 +235408,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234716,10 +235483,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 status: type: string @@ -234800,10 +235567,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234880,10 +235647,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234977,10 +235744,10 @@ x-webhooks: - name required: - repository - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235060,10 +235827,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 sender: *4 required: @@ -235142,10 +235909,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 sender: *4 required: @@ -235224,10 +235991,10 @@ x-webhooks: type: string enum: - edited - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 changes: type: object @@ -235289,16 +236056,16 @@ x-webhooks: properties: added: type: array - items: *646 + items: *648 deleted: type: array - items: *646 + items: *648 updated: type: array items: type: object properties: - rule: *646 + rule: *648 changes: type: object properties: @@ -235532,10 +236299,10 @@ x-webhooks: - from required: - owner - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235613,10 +236380,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235694,7 +236461,7 @@ x-webhooks: type: string enum: - create - alert: &838 + alert: &853 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -235816,10 +236583,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236025,10 +236792,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236106,11 +236873,11 @@ x-webhooks: type: string enum: - reopen - alert: *838 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *853 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236309,10 +237076,10 @@ x-webhooks: enum: - fixed - open - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236390,7 +237157,7 @@ x-webhooks: type: string enum: - assigned - alert: &840 + alert: &855 type: object properties: number: *188 @@ -236532,12 +237299,12 @@ x-webhooks: properties: *20 required: *21 nullable: true - metadata: *839 + metadata: *854 assignee: *4 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236615,11 +237382,11 @@ x-webhooks: type: string enum: - created - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236700,11 +237467,11 @@ x-webhooks: type: string enum: - created - alert: *840 - installation: *778 - location: *841 - organization: *779 - repository: *780 + alert: *855 + installation: *793 + location: *856 + organization: *794 + repository: *795 sender: *4 required: - location @@ -236942,11 +237709,11 @@ x-webhooks: type: string enum: - metadata_created - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237023,11 +237790,11 @@ x-webhooks: type: string enum: - metadata_removed - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237104,11 +237871,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237186,11 +237953,11 @@ x-webhooks: type: string enum: - reopened - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237268,11 +238035,11 @@ x-webhooks: type: string enum: - resolved - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237350,12 +238117,12 @@ x-webhooks: type: string enum: - unassigned - alert: *840 + alert: *855 assignee: *4 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237433,11 +238200,11 @@ x-webhooks: type: string enum: - validated - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -237563,10 +238330,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *780 - enterprise: *777 - installation: *778 - organization: *779 + repository: *795 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -237644,11 +238411,11 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - security_advisory: &842 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + security_advisory: &857 description: The details of the security advisory, including summary, description, and severity. type: object @@ -237831,11 +238598,11 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - security_advisory: *842 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + security_advisory: *857 sender: *4 required: - action @@ -237908,10 +238675,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -238096,10 +238863,10 @@ x-webhooks: type: object properties: security_and_analysis: *312 - enterprise: *777 - installation: *778 - organization: *779 - repository: *357 + enterprise: *792 + installation: *793 + organization: *794 + repository: *359 sender: *4 required: - changes @@ -238177,12 +238944,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: &843 + sponsorship: &858 type: object properties: created_at: @@ -238483,12 +239250,12 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - sponsorship @@ -238576,12 +239343,12 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -238658,17 +239425,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &844 + effective_date: &859 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - sponsorship @@ -238742,7 +239509,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &845 + changes: &860 type: object properties: tier: @@ -238786,13 +239553,13 @@ x-webhooks: - from required: - tier - effective_date: *844 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + effective_date: *859 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -238869,13 +239636,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *845 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + changes: *860 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -238949,10 +239716,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -239035,10 +239802,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -239458,15 +240225,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *777 + enterprise: *792 id: description: The unique identifier of the status. type: integer - installation: *778 + installation: *793 name: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 sha: description: The Commit SHA. @@ -239581,9 +240348,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239672,9 +240439,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239763,9 +240530,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239854,9 +240621,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239932,12 +240699,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - team: &846 + team: &861 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -240160,9 +240927,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -240620,7 +241387,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -240696,9 +241463,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -241156,7 +241923,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -241233,9 +242000,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -241693,7 +242460,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -241837,9 +242604,9 @@ x-webhooks: - from required: - permissions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -242297,7 +243064,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - changes @@ -242375,9 +243142,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -242835,7 +243602,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -242911,10 +243678,10 @@ x-webhooks: type: string enum: - started - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -242987,16 +243754,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *777 + enterprise: *792 inputs: type: object nullable: true additionalProperties: true - installation: *778 - organization: *779 + installation: *793 + organization: *794 ref: type: string - repository: *780 + repository: *795 sender: *4 workflow: type: string @@ -243078,10 +243845,10 @@ x-webhooks: type: string enum: - completed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: allOf: @@ -243318,7 +244085,7 @@ x-webhooks: type: string required: - conclusion - deployment: *519 + deployment: *521 required: - action - repository @@ -243397,10 +244164,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: allOf: @@ -243660,7 +244427,7 @@ x-webhooks: required: - status - steps - deployment: *519 + deployment: *521 required: - action - repository @@ -243739,10 +244506,10 @@ x-webhooks: type: string enum: - queued - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: type: object @@ -243877,7 +244644,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *519 + deployment: *521 required: - action - repository @@ -243956,10 +244723,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: type: object @@ -244095,7 +244862,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *519 + deployment: *521 required: - action - repository @@ -244175,12 +244942,12 @@ x-webhooks: type: string enum: - completed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object @@ -245179,12 +245946,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object @@ -246168,12 +246935,12 @@ x-webhooks: type: string enum: - requested - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 4df8dd2e5e..33e0a5d8ac 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -7824,7 +7824,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -8826,7 +8826,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9682,7 +9682,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10169,7 +10169,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12209,7 +12209,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13262,7 +13262,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14232,7 +14232,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14913,7 +14913,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16233,15 +16233,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16570,21 +16570,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -16953,21 +16956,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17116,21 +17122,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17210,21 +17219,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17368,21 +17380,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17608,8 +17623,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -144436,7 +144454,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -145453,7 +145471,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -217669,23 +217687,23 @@ } } }, - "/orgs/{org}/secret-scanning/pattern-configurations": { + "/orgs/{org}/secret-scanning/custom-patterns": { "get": { - "summary": "List organization pattern configurations", - "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "secret-scanning" ], - "operationId": "secret-scanning/list-org-pattern-configs", + "operationId": "secret-scanning/list-org-custom-patterns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "secret-scanning", - "subcategory": "push-protection" + "subcategory": "custom-patterns" }, "parameters": [ { @@ -217696,6 +217714,79 @@ "schema": { "type": "string" } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -217704,198 +217795,1534 @@ "content": { "application/json": { "schema": { - "title": "Secret scanning pattern configuration", - "description": "A collection of secret scanning patterns and their settings related to push protection.", - "type": "object", - "properties": { - "pattern_config_version": { - "type": "string", - "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", - "nullable": true - }, - "provider_pattern_overrides": { - "type": "array", - "description": "Overrides for partner patterns.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" } - } - }, - "custom_pattern_overrides": { - "type": "array", - "description": "Overrides for custom patterns defined by the organization.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." } - } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] } }, "examples": { "default": { - "value": { - "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "provider_pattern_overrides": [ - { - "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", - "slug": "github_personal_access_token_legacy_v2", - "display_name": "GitHub Personal Access Token (Legacy v2)", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 2, - "false_positive_rate": 13, - "bypass_rate": 13, - "default_setting": "enabled", - "setting": "enabled", - "enterprise_setting": "enabled" - } - ], - "custom_pattern_overrides": [ - { - "token_type": "cp_2", - "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "slug": "custom-api-key", - "display_name": "Custom API Key", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 3, - "false_positive_rate": 20, - "bypass_rate": 20, - "default_setting": "disabled", - "setting": "enabled" - } - ] - } + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } } } } @@ -378076,7 +379503,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -565978,6 +567405,1451 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -630157,7 +633029,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -707385,7 +710257,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -898741,7 +901613,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -901352,7 +904224,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -903870,7 +906742,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -906388,7 +909260,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -909038,7 +911910,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -911695,7 +914567,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -915977,7 +918849,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index b2b64b1096..0773c35d48 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -836,7 +836,7 @@ paths: - subscriptions_url - type - url - type: &345 + type: &347 type: string description: The type of credit the user is receiving. enum: @@ -1001,7 +1001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &699 + - &714 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -4704,7 +4704,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6649,15 +6650,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -6906,19 +6911,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7170,18 +7180,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7271,18 +7287,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7305,18 +7327,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - &35 name: classroom_id @@ -7350,18 +7378,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - *35 - *19 @@ -7403,6 +7437,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -11960,7 +11997,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &508 + - &510 name: has in: query description: |- @@ -12086,7 +12123,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &509 + security_advisory: &511 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12333,14 +12370,14 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &510 + auto_dismissed_at: &512 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &511 + dismissal_request: &513 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -14028,7 +14065,7 @@ paths: properties: action: type: string - discussion: &795 + discussion: &810 title: Discussion description: A Discussion in a repository. type: object @@ -14395,7 +14432,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &563 + properties: &565 id: type: integer format: int64 @@ -14766,7 +14803,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &710 + sub_issues_summary: &725 title: Sub-issues Summary type: object properties: @@ -14853,7 +14890,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &589 + properties: &591 pinned_at: type: string format: date-time @@ -14865,7 +14902,7 @@ paths: properties: *20 required: *21 nullable: true - required: &590 + required: &592 - pinned_at - pinned_by nullable: true @@ -14874,13 +14911,13 @@ paths: description: Details about why an issue comment was minimized. type: object - properties: &591 + properties: &593 reason: description: The reason the comment was minimized. type: string nullable: true example: low-quality - required: &592 + required: &594 - reason nullable: true required: &90 @@ -14893,7 +14930,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &711 + issue_dependencies_summary: &726 title: Issue Dependencies Summary type: object properties: @@ -14912,7 +14949,7 @@ paths: - total_blocking issue_field_values: type: array - items: &573 + items: &575 title: Issue Field Value description: A value assigned to an issue field type: object @@ -15004,7 +15041,7 @@ paths: - node_id - data_type - value - required: &564 + required: &566 - closed_at - comments - comments_url @@ -15041,7 +15078,7 @@ paths: action: type: string issue: *88 - comment: &559 + comment: &561 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15705,7 +15742,7 @@ paths: type: string release: allOf: - - &636 + - &638 title: Release description: A release. type: object @@ -15776,7 +15813,7 @@ paths: author: *4 assets: type: array - items: &637 + items: &639 title: Release Asset description: Data related to a release. type: object @@ -19454,14 +19491,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &354 + - &356 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &355 + - &357 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19523,7 +19560,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &358 + '301': &360 description: Moved permanently content: application/json: @@ -19545,7 +19582,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &612 + - &614 name: all description: If `true`, show notifications marked as read. in: query @@ -19553,7 +19590,7 @@ paths: schema: type: boolean default: false - - &613 + - &615 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19563,7 +19600,7 @@ paths: type: boolean default: false - *95 - - &614 + - &616 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -20091,7 +20128,7 @@ paths: - url - subscription_url examples: - default: &615 + default: &617 value: - id: '1' repository: @@ -22005,7 +22042,7 @@ paths: parameters: - *78 - *124 - - &771 + - &786 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -22117,7 +22154,7 @@ paths: - *124 - *125 - *126 - - &772 + - &787 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22125,7 +22162,7 @@ paths: schema: type: string - *129 - - &773 + - &788 name: sku description: The SKU to query for usage. in: query @@ -23018,7 +23055,7 @@ paths: type: integer repository_cache_usages: type: array - items: &365 + items: &367 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -24360,7 +24397,7 @@ paths: - all - local_only - selected - selected_actions_url: &370 + selected_actions_url: &372 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -24443,7 +24480,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &376 type: object properties: days: @@ -24485,7 +24522,7 @@ paths: required: true content: application/json: - schema: &375 + schema: &377 type: object properties: days: @@ -24542,7 +24579,7 @@ paths: required: - approval_policy examples: - default: &376 + default: &378 value: approval_policy: first_time_contributors '404': *6 @@ -24601,7 +24638,7 @@ paths: description: Response content: application/json: - schema: &377 + schema: &379 type: object required: - run_workflows_from_fork_pull_requests @@ -24655,7 +24692,7 @@ paths: required: true content: application/json: - schema: &378 + schema: &380 type: object required: - run_workflows_from_fork_pull_requests @@ -25290,7 +25327,7 @@ paths: description: Response content: application/json: - schema: &379 + schema: &381 type: object properties: default_workflow_permissions: &156 @@ -25341,7 +25378,7 @@ paths: required: false content: application/json: - schema: &380 + schema: &382 type: object properties: default_workflow_permissions: *156 @@ -26481,7 +26518,7 @@ paths: application/json: schema: type: array - items: &381 + items: &383 title: Runner Application description: Runner Application type: object @@ -26506,7 +26543,7 @@ paths: - download_url - filename examples: - default: &382 + default: &384 value: - os: osx architecture: x64 @@ -26592,7 +26629,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &383 + '201': &385 description: Response content: application/json: @@ -26703,7 +26740,7 @@ paths: - token - expires_at examples: - default: &384 + default: &386 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -26742,7 +26779,7 @@ paths: application/json: schema: *167 examples: - default: &385 + default: &387 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -26776,7 +26813,7 @@ paths: application/json: schema: *165 examples: - default: &386 + default: &388 value: id: 23 name: MBP @@ -27003,7 +27040,7 @@ paths: - *78 - *164 responses: - '200': &387 + '200': &389 description: Response content: application/json: @@ -27060,7 +27097,7 @@ paths: parameters: - *78 - *164 - - &388 + - &390 name: name description: The name of a self-hosted runner's custom label. in: path @@ -29629,12 +29666,12 @@ paths: required: - subject_digests examples: - default: &752 + default: &767 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &753 + withPredicateType: &768 value: subject_digests: - sha256:abc123 @@ -29678,7 +29715,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &754 + default: &769 value: attestations_subject_digests: - sha256:abc: @@ -30011,7 +30048,7 @@ paths: initiator: type: string examples: - default: &414 + default: &416 value: attestations: - bundle: @@ -30951,7 +30988,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *78 - - &441 + - &443 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -30961,7 +30998,7 @@ paths: schema: &195 type: string description: The name of the tool used to generate the code scanning analysis. - - &442 + - &444 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -30984,7 +31021,7 @@ paths: be returned. in: query required: false - schema: &444 + schema: &446 type: string description: State of a code scanning alert. enum: @@ -31007,7 +31044,7 @@ paths: be returned. in: query required: false - schema: &445 + schema: &447 type: string description: Severity of a code scanning alert. enum: @@ -31041,7 +31078,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: &446 + instances_url: &448 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -31064,7 +31101,7 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: &447 + dismissed_reason: &449 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -31073,13 +31110,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &448 + dismissed_comment: &450 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &449 + rule: &451 type: object properties: id: @@ -31132,7 +31169,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &450 + tool: &452 type: object properties: name: *195 @@ -31142,26 +31179,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *196 - most_recent_instance: &451 + most_recent_instance: &453 type: object properties: - ref: &443 + ref: &445 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &461 + analysis_key: &463 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &462 + environment: &464 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &463 + category: &465 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -31181,7 +31218,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &464 + location: &466 type: object description: Describe a region within a file for the alert. properties: @@ -31202,7 +31239,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &465 + items: &467 type: string description: A classification of the file. For example to identify it as generated. @@ -32533,7 +32570,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &477 + properties: &479 name: type: string description: The name of the machine. @@ -32575,7 +32612,7 @@ paths: - ready - in_progress nullable: true - required: &478 + required: &480 - name - display_name - operating_system @@ -33443,7 +33480,7 @@ paths: - updated_at - visibility examples: - default: &479 + default: &481 value: total_count: 2 secrets: @@ -33481,7 +33518,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &482 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -33510,7 +33547,7 @@ paths: - key_id - key examples: - default: &481 + default: &483 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33542,7 +33579,7 @@ paths: application/json: schema: *203 examples: - default: &483 + default: &485 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -37079,7 +37116,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &516 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -37096,7 +37133,7 @@ paths: - key_id - key examples: - default: &515 + default: &517 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -38892,7 +38929,7 @@ paths: application/json: schema: *22 examples: - default: &552 + default: &554 value: id: 1 account: @@ -39117,7 +39154,7 @@ paths: required: true content: application/json: - schema: &553 + schema: &555 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -39923,7 +39960,7 @@ paths: type: array items: *257 examples: - default: &557 + default: &559 value: - id: 410 node_id: IT_kwDNAd3NAZo @@ -40447,7 +40484,7 @@ paths: application/json: schema: *262 examples: - default: &476 + default: &478 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -41697,7 +41734,7 @@ paths: parameters: - *78 - *269 - - &734 + - &749 name: repo_name description: repo_name parameter in: path @@ -42331,7 +42368,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &346 + items: &348 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -42625,7 +42662,7 @@ paths: - nuget - container - *78 - - &735 + - &750 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -42666,7 +42703,7 @@ paths: default: *276 '403': *29 '401': *25 - '400': &737 + '400': &752 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -44874,7 +44911,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &826 + properties: &841 id: type: number description: The unique identifier of the status update. @@ -44922,7 +44959,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &827 + required: &842 - id - node_id - created_at @@ -45136,7 +45173,7 @@ paths: content: oneOf: - *88 - - &493 + - &495 title: Pull Request Simple description: Pull Request Simple type: object @@ -45351,7 +45388,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: &622 + auto_merge: &624 title: Auto merge description: The status of auto merging a pull request. type: object @@ -45727,7 +45764,7 @@ paths: - updated_at - project_url examples: - default: &758 + default: &773 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -45904,7 +45941,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &759 + items: &774 type: object properties: name: @@ -45941,7 +45978,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &760 + iteration_configuration: &775 type: object description: The configuration for iteration fields. properties: @@ -45991,7 +46028,7 @@ paths: value: name: Due date data_type: date - single_select_field: &761 + single_select_field: &776 summary: Create a single select field value: name: Priority @@ -46018,7 +46055,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &762 + iteration_field: &777 summary: Create an iteration field value: name: Sprint @@ -46044,7 +46081,7 @@ paths: application/json: schema: *297 examples: - text_field: &763 + text_field: &778 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46053,7 +46090,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &764 + number_field: &779 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46062,7 +46099,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &765 + date_field: &780 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46071,7 +46108,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &766 + single_select_field: &781 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46105,7 +46142,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &767 + iteration_field: &782 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46151,7 +46188,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *293 - - &768 + - &783 name: field_id description: The unique identifier of the field. in: path @@ -46166,7 +46203,7 @@ paths: application/json: schema: *297 examples: - default: &769 + default: &784 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47363,7 +47400,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &749 + schema: &764 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -47540,7 +47577,7 @@ paths: parameters: - *293 - *78 - - &770 + - &785 name: view_number description: The number that identifies the project view. in: path @@ -48477,7 +48514,7 @@ paths: description: Response content: application/json: - schema: &357 + schema: &359 title: Full Repository description: Full Repository type: object @@ -48875,7 +48912,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &498 + properties: &500 url: type: string format: uri @@ -48891,7 +48928,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &499 + required: &501 - url - key - name @@ -48980,7 +49017,7 @@ paths: - network_count - subscribers_count examples: - default: &359 + default: &361 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -49501,7 +49538,7 @@ paths: - *78 - *17 - *19 - - &645 + - &647 name: targets description: | A comma-separated list of rule targets to filter by. @@ -49783,7 +49820,7 @@ paths: - repository_property rules: type: array - items: &646 + items: &648 title: Repository Rule type: object description: A repository rule. @@ -49845,7 +49882,7 @@ paths: type: string enum: - required_linear_history - - &643 + - &645 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -50484,7 +50521,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &644 + - &646 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -50796,7 +50833,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *78 - - &647 + - &649 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -50811,7 +50848,7 @@ paths: in: query schema: type: string - - &648 + - &650 name: time_period description: |- The time period to filter by. @@ -50827,14 +50864,14 @@ paths: - week - month default: day - - &649 + - &651 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &650 + - &652 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -50847,7 +50884,7 @@ paths: - bypass - all default: all - - &651 + - &653 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -50870,7 +50907,7 @@ paths: description: Response content: application/json: - schema: &652 + schema: &654 title: Rule Suites description: Response type: array @@ -50925,7 +50962,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &653 + default: &655 value: - id: 21 actor_id: 12 @@ -50969,7 +51006,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *78 - - &654 + - &656 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -50985,7 +51022,7 @@ paths: description: Response content: application/json: - schema: &655 + schema: &657 title: Rule Suite description: Response type: object @@ -51084,7 +51121,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &656 + default: &658 value: id: 21 actor_id: 12 @@ -51331,7 +51368,7 @@ paths: type: string format: date-time examples: - default: &658 + default: &660 value: - version_id: 3 actor: @@ -51384,7 +51421,7 @@ paths: description: Response content: application/json: - schema: &659 + schema: &661 allOf: - *342 - type: object @@ -51456,7 +51493,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *78 - - &660 + - &662 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -51467,7 +51504,7 @@ paths: enum: - open - resolved - - &661 + - &663 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -51477,7 +51514,7 @@ paths: required: false schema: type: string - - &662 + - &664 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -51488,7 +51525,7 @@ paths: required: false schema: type: string - - &663 + - &665 name: exclude_providers in: query description: |- @@ -51499,7 +51536,7 @@ paths: required: false schema: type: string - - &664 + - &666 name: providers in: query description: |- @@ -51510,7 +51547,7 @@ paths: required: false schema: type: string - - &665 + - &667 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -51519,7 +51556,7 @@ paths: required: false schema: type: string - - &666 + - &668 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -51538,7 +51575,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &667 + - &669 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -51553,7 +51590,7 @@ paths: - *62 - *19 - *17 - - &668 + - &670 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -51563,7 +51600,7 @@ paths: required: false schema: type: string - - &669 + - &671 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -51573,7 +51610,7 @@ paths: required: false schema: type: string - - &670 + - &672 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -51582,7 +51619,7 @@ paths: required: false schema: type: string - - &671 + - &673 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -51591,7 +51628,7 @@ paths: schema: type: boolean default: false - - &672 + - &674 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -51600,7 +51637,7 @@ paths: schema: type: boolean default: false - - &673 + - &675 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -51609,7 +51646,7 @@ paths: schema: type: boolean default: false - - &674 + - &676 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -51620,7 +51657,7 @@ paths: required: false schema: type: boolean - - &675 + - &677 name: included_metadata in: query description: |- @@ -51631,7 +51668,7 @@ paths: required: false schema: type: string - - &676 + - &678 name: owner_email_hash in: query description: |- @@ -51669,14 +51706,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &677 + state: &679 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &678 + resolution: &680 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -51793,8 +51830,8 @@ paths: pull request. ' - oneOf: &679 - - &681 + oneOf: &681 + - &683 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -51852,7 +51889,7 @@ paths: - blob_url - commit_sha - commit_url - - &682 + - &684 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -51907,7 +51944,7 @@ paths: - page_url - commit_sha - commit_url - - &683 + - &685 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -51927,7 +51964,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &684 + - &686 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -51947,7 +51984,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &685 + - &687 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -51967,7 +52004,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &686 + - &688 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -51981,7 +52018,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &687 + - &689 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -51995,7 +52032,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &688 + - &690 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52009,7 +52046,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &689 + - &691 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -52029,7 +52066,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &690 + - &692 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -52049,7 +52086,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &691 + - &693 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -52069,7 +52106,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &692 + - &694 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -52089,7 +52126,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &693 + - &695 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -52321,6 +52358,526 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - &696 + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - &697 + name: push_protection + description: Filter custom patterns by whether push protection is enabled. + When absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - &698 + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &343 + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, + derived from its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom + pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: &344 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created + in ISO 8601 format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated + in ISO 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + examples: + default: &699 + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: &700 + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + examples: + default: &701 + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *343 + examples: + default: &702 + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: &703 + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in + a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the + error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: &704 + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: *344 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: &705 + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': &345 + description: Precondition Failed + content: + application/json: + schema: *3 + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: &706 + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable + field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, + or `must_not_match`) must also be provided. Only provided fields will + be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: *344 + examples: + default: &707 + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *343 + examples: + default: &708 + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' + '400': *14 + '403': *29 + '404': *6 + '412': *345 + '422': *15 "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -52352,16 +52909,11 @@ paths: related to push protection. type: object properties: - pattern_config_version: &344 - type: string - description: The version of the entity. This is used to confirm - you're updating the current version of the entity and mitigate - unintentionally overriding someone else's update. - nullable: true + pattern_config_version: *344 provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &343 + items: &346 type: object properties: token_type: @@ -52427,7 +52979,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *343 + items: *346 examples: default: value: @@ -52608,7 +53160,7 @@ paths: application/json: schema: type: array - items: &697 + items: &712 description: A repository security advisory. type: object properties: @@ -52810,7 +53362,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 credits_detailed: type: array nullable: true @@ -52820,7 +53372,7 @@ paths: type: object properties: user: *4 - type: *345 + type: *347 state: type: string description: The state of the user's acceptance of the @@ -52880,7 +53432,7 @@ paths: - private_fork additionalProperties: false examples: - default: &698 + default: &713 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -53267,7 +53819,7 @@ paths: application/json: schema: type: array - items: *346 + items: *348 examples: default: value: @@ -53620,7 +54172,7 @@ paths: type: integer network_configurations: type: array - items: &347 + items: &349 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -53766,9 +54318,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: &348 + default: &350 value: id: 123456789ABCDEF name: My network configuration @@ -53797,7 +54349,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - &349 + - &351 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -53809,9 +54361,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *348 + default: *350 headers: Link: *70 x-github: @@ -53833,7 +54385,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - *349 + - *351 requestBody: required: true content: @@ -53886,9 +54438,9 @@ paths: description: Response content: application/json: - schema: *347 + schema: *349 examples: - default: *348 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53908,7 +54460,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *78 - - *349 + - *351 responses: '204': description: Response @@ -54113,7 +54665,7 @@ paths: description: Response content: application/json: - schema: &350 + schema: &352 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -54440,7 +54992,7 @@ paths: - repos_count - organization examples: - default: &351 + default: &353 value: id: 1 node_id: MDQ6VGVhbTE= @@ -54517,9 +55069,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 x-github: githubCloudOnly: false @@ -54603,16 +55155,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '201': description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 '422': *15 '403': *29 @@ -54642,7 +55194,7 @@ paths: responses: '204': description: Response - '422': &352 + '422': &354 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -54681,7 +55233,7 @@ paths: default: *252 headers: Link: *70 - '422': *352 + '422': *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54725,7 +55277,7 @@ paths: application/json: schema: type: array - items: &713 + items: &728 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -54844,7 +55396,7 @@ paths: - type - url examples: - default: &714 + default: &729 value: - login: octocat id: 1 @@ -54903,7 +55455,7 @@ paths: description: Response content: application/json: - schema: &353 + schema: &355 title: Team Membership description: Team Membership type: object @@ -54930,7 +55482,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &715 + response-if-user-is-a-team-maintainer: &730 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -54993,9 +55545,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: &716 + response-if-users-membership-with-team-is-now-pending: &731 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -55102,14 +55654,14 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &717 + schema: &732 title: Team Repository description: A team's access to a repository. type: object @@ -55673,8 +56225,8 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -55721,8 +56273,8 @@ paths: parameters: - *78 - *80 - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -55759,7 +56311,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &718 + response-if-child-teams-exist: &733 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -55912,7 +56464,7 @@ paths: resources: type: object properties: - core: &356 + core: &358 title: Rate Limit type: object properties: @@ -55929,17 +56481,17 @@ paths: - remaining - reset - used - graphql: *356 - search: *356 - code_search: *356 - source_import: *356 - integration_manifest: *356 - actions_runner_registration: *356 - scim: *356 - dependency_snapshots: *356 - dependency_sbom: *356 - code_scanning_autofix: *356 - copilot_usage_records: *356 + graphql: *358 + search: *358 + code_search: *358 + source_import: *358 + integration_manifest: *358 + actions_runner_registration: *358 + scim: *358 + dependency_snapshots: *358 + dependency_sbom: *358 + code_scanning_autofix: *358 + copilot_usage_records: *358 required: - core - search @@ -56036,14 +56588,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *357 + schema: *359 examples: default-response: summary: Default response @@ -56547,7 +57099,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *358 + '301': *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56565,8 +57117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -56876,10 +57428,10 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 - '307': &360 + default: *361 + '307': &362 description: Temporary Redirect content: application/json: @@ -56908,8 +57460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -56931,7 +57483,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *360 + '307': *362 '404': *6 '409': *54 x-github: @@ -56955,11 +57507,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - - &392 + - &394 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -56982,7 +57534,7 @@ paths: type: integer artifacts: type: array - items: &361 + items: &363 title: Artifact description: An artifact type: object @@ -57060,7 +57612,7 @@ paths: - expires_at - updated_at examples: - default: &393 + default: &395 value: total_count: 2 artifacts: @@ -57121,9 +57673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *354 - - *355 - - &362 + - *356 + - *357 + - &364 name: artifact_id description: The unique identifier of the artifact. in: path @@ -57135,7 +57687,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *363 examples: default: value: @@ -57173,9 +57725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *354 - - *355 - - *362 + - *356 + - *357 + - *364 responses: '204': description: Response @@ -57199,9 +57751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *354 - - *355 - - *362 + - *356 + - *357 + - *364 - name: archive_format in: path required: true @@ -57211,11 +57763,11 @@ paths: '302': description: Response headers: - Location: &517 + Location: &519 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &558 + '410': &560 description: Gone content: application/json: @@ -57240,14 +57792,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &363 + schema: &365 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -57280,13 +57832,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *363 + schema: *365 examples: selected_actions: *42 responses: @@ -57315,14 +57867,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &364 + schema: &366 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -57355,13 +57907,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *364 + schema: *366 examples: selected_actions: *44 responses: @@ -57392,14 +57944,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *365 + schema: *367 examples: default: value: @@ -57425,11 +57977,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - - &366 + - &368 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -57463,7 +58015,7 @@ paths: description: Response content: application/json: - schema: &367 + schema: &369 title: Repository actions caches description: Repository actions caches type: object @@ -57505,7 +58057,7 @@ paths: - total_count - actions_caches examples: - default: &368 + default: &370 value: total_count: 1 actions_caches: @@ -57537,23 +58089,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *354 - - *355 + - *356 + - *357 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *366 + - *368 responses: '200': description: Response content: application/json: - schema: *367 + schema: *369 examples: - default: *368 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57573,8 +58125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *354 - - *355 + - *356 + - *357 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -57603,8 +58155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *48 responses: @@ -57686,8 +58238,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: concurrency_group_name description: The name of the concurrency group. in: path @@ -57839,9 +58391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *354 - - *355 - - &369 + - *356 + - *357 + - &371 name: job_id description: The unique identifier of the job. in: path @@ -57853,7 +58405,7 @@ paths: description: Response content: application/json: - schema: &396 + schema: &398 title: Job description: Information of a job execution in a workflow run type: object @@ -58160,9 +58712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *354 - - *355 - - *369 + - *356 + - *357 + - *371 responses: '302': description: Response @@ -58190,9 +58742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *354 - - *355 - - *369 + - *356 + - *357 + - *371 requestBody: required: false content: @@ -58242,8 +58794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Status response @@ -58302,8 +58854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -58371,8 +58923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -58390,7 +58942,7 @@ paths: type: integer secrets: type: array - items: &398 + items: &400 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -58410,7 +58962,7 @@ paths: - created_at - updated_at examples: - default: &399 + default: &401 value: total_count: 2 secrets: @@ -58443,8 +58995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -58462,7 +59014,7 @@ paths: type: integer variables: type: array - items: &400 + items: &402 title: Actions Variable type: object properties: @@ -58492,7 +59044,7 @@ paths: - created_at - updated_at examples: - default: &401 + default: &403 value: total_count: 2 variables: @@ -58525,8 +59077,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -58535,11 +59087,11 @@ paths: schema: type: object properties: - enabled: &371 + enabled: &373 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *148 - selected_actions_url: *370 + selected_actions_url: *372 sha_pinning_required: *149 required: - enabled @@ -58568,8 +59120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -58580,7 +59132,7 @@ paths: schema: type: object properties: - enabled: *371 + enabled: *373 allowed_actions: *148 sha_pinning_required: *149 required: @@ -58612,14 +59164,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &372 + schema: &374 type: object properties: access_level: @@ -58636,7 +59188,7 @@ paths: required: - access_level examples: - default: &373 + default: &375 value: access_level: organization x-github: @@ -58660,15 +59212,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *372 + schema: *374 examples: - default: *373 + default: *375 responses: '204': description: Response @@ -58692,14 +59244,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *374 + schema: *376 examples: default: value: @@ -58723,8 +59275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Empty response for successful settings update @@ -58734,7 +59286,7 @@ paths: required: true content: application/json: - schema: *375 + schema: *377 examples: default: summary: Set retention days @@ -58758,8 +59310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -58767,7 +59319,7 @@ paths: application/json: schema: *150 examples: - default: *376 + default: *378 '404': *6 x-github: enabledForGitHubApps: true @@ -58786,8 +59338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -58821,14 +59373,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *377 + schema: *379 examples: default: *151 '403': *29 @@ -58850,13 +59402,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *378 + schema: *380 examples: default: *151 responses: @@ -58882,8 +59434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -58910,8 +59462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -58943,14 +59495,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: default: *158 x-github: @@ -58973,8 +59525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Success response @@ -58985,7 +59537,7 @@ paths: required: true content: application/json: - schema: *380 + schema: *382 examples: default: *158 x-github: @@ -59014,8 +59566,8 @@ paths: in: query schema: type: string - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -59059,8 +59611,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -59068,9 +59620,9 @@ paths: application/json: schema: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59092,8 +59644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -59136,7 +59688,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *383 + '201': *385 '404': *6 '422': *7 '409': *54 @@ -59167,8 +59719,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -59176,7 +59728,7 @@ paths: application/json: schema: *167 examples: - default: *384 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59204,8 +59756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -59213,7 +59765,7 @@ paths: application/json: schema: *167 examples: - default: *385 + default: *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59235,8 +59787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '200': @@ -59245,7 +59797,7 @@ paths: application/json: schema: *165 examples: - default: *386 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59266,8 +59818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '204': @@ -59294,8 +59846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: '200': *169 @@ -59320,8 +59872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 requestBody: required: true @@ -59370,8 +59922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 requestBody: required: true @@ -59421,11 +59973,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 responses: - '200': *387 + '200': *389 '404': *6 x-github: githubCloudOnly: false @@ -59452,10 +60004,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *164 - - *388 + - *390 responses: '200': *169 '404': *6 @@ -59483,9 +60035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *354 - - *355 - - &404 + - *356 + - *357 + - &406 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -59493,7 +60045,7 @@ paths: required: false schema: type: string - - &405 + - &407 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -59501,7 +60053,7 @@ paths: required: false schema: type: string - - &406 + - &408 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -59510,7 +60062,7 @@ paths: required: false schema: type: string - - &407 + - &409 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -59537,7 +60089,7 @@ paths: - pending - *17 - *19 - - &408 + - &410 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -59546,7 +60098,7 @@ paths: schema: type: string format: date-time - - &389 + - &391 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -59555,13 +60107,13 @@ paths: schema: type: boolean default: false - - &409 + - &411 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &410 + - &412 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -59584,7 +60136,7 @@ paths: type: integer workflow_runs: type: array - items: &390 + items: &392 title: Workflow Run description: An invocation of a workflow type: object @@ -59732,7 +60284,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &434 + properties: &436 id: type: string description: SHA for the commit @@ -59783,7 +60335,7 @@ paths: - name - email nullable: true - required: &435 + required: &437 - id - tree_id - message @@ -59830,7 +60382,7 @@ paths: - workflow_url - pull_requests examples: - default: &411 + default: &413 value: total_count: 1 workflow_runs: @@ -60066,24 +60618,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *354 - - *355 - - &391 + - *356 + - *357 + - &393 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *389 + - *391 responses: '200': description: Response content: application/json: - schema: *390 + schema: *392 examples: - default: &394 + default: &396 value: id: 30433642 name: Build @@ -60324,9 +60876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '204': description: Response @@ -60349,9 +60901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -60470,9 +61022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '201': description: Response @@ -60505,12 +61057,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - *17 - *19 - - *392 + - *394 - *62 responses: '200': @@ -60527,9 +61079,9 @@ paths: type: integer artifacts: type: array - items: *361 + items: *363 examples: - default: *393 + default: *395 headers: Link: *70 x-github: @@ -60553,25 +61105,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *354 - - *355 - - *391 - - &395 + - *356 + - *357 + - *393 + - &397 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *389 + - *391 responses: '200': description: Response content: application/json: - schema: *390 + schema: *392 examples: - default: *394 + default: *396 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60594,10 +61146,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *354 - - *355 - - *391 - - *395 + - *356 + - *357 + - *393 + - *397 - *17 - *19 responses: @@ -60615,9 +61167,9 @@ paths: type: integer jobs: type: array - items: *396 + items: *398 examples: - default: &397 + default: &399 value: total_count: 1 jobs: @@ -60730,10 +61282,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *354 - - *355 - - *391 - - *395 + - *356 + - *357 + - *393 + - *397 responses: '302': description: Response @@ -60761,9 +61313,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '202': description: Response @@ -60809,9 +61361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - *17 - *47 - *48 @@ -60982,9 +61534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: true content: @@ -61051,9 +61603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '202': description: Response @@ -61086,9 +61638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -61118,9 +61670,9 @@ paths: type: integer jobs: type: array - items: *396 + items: *398 examples: - default: *397 + default: *399 headers: Link: *70 x-github: @@ -61145,9 +61697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '302': description: Response @@ -61174,9 +61726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '204': description: Response @@ -61203,9 +61755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -61265,7 +61817,7 @@ paths: items: type: object properties: - type: &524 + type: &526 type: string description: The type of reviewer. enum: @@ -61350,9 +61902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: true content: @@ -61399,12 +61951,12 @@ paths: application/json: schema: type: array - items: &519 + items: &521 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &789 + properties: &804 url: type: string format: uri @@ -61489,7 +62041,7 @@ paths: nullable: true properties: *83 required: *84 - required: &790 + required: &805 - id - node_id - sha @@ -61505,7 +62057,7 @@ paths: - created_at - updated_at examples: - default: &520 + default: &522 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -61561,9 +62113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: false content: @@ -61607,9 +62159,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 requestBody: required: false content: @@ -61662,9 +62214,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *354 - - *355 - - *391 + - *356 + - *357 + - *393 responses: '200': description: Response @@ -61801,8 +62353,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -61820,9 +62372,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -61847,8 +62399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -61878,17 +62430,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: &412 + default: &414 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -61914,8 +62466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -61973,8 +62525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -62000,8 +62552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -62019,9 +62571,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -62044,8 +62596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -62097,17 +62649,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: &413 + default: &415 value: name: USERNAME value: octocat @@ -62133,8 +62685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 requestBody: required: true @@ -62177,8 +62729,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '204': @@ -62204,8 +62756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -62223,7 +62775,7 @@ paths: type: integer workflows: type: array - items: &402 + items: &404 title: Workflow description: A GitHub Actions workflow type: object @@ -62330,9 +62882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *354 - - *355 - - &403 + - *356 + - *357 + - &405 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -62347,7 +62899,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *404 examples: default: value: @@ -62380,9 +62932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '204': description: Response @@ -62407,9 +62959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '200': description: Response including the workflow run ID and URLs. @@ -62489,9 +63041,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '204': description: Response @@ -62518,19 +63070,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *354 - - *355 - - *403 - - *404 + - *356 + - *357 - *405 - *406 - *407 - - *17 - - *19 - *408 - - *389 - *409 + - *17 + - *19 - *410 + - *391 + - *411 + - *412 responses: '200': description: Response @@ -62546,9 +63098,9 @@ paths: type: integer workflow_runs: type: array - items: *390 + items: *392 examples: - default: *411 + default: *413 headers: Link: *70 x-github: @@ -62580,9 +63132,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *354 - - *355 - - *403 + - *356 + - *357 + - *405 responses: '200': description: Response @@ -62643,8 +63195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *354 - - *355 + - *356 + - *357 - *62 - *17 - *47 @@ -62813,8 +63365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-organization-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -62832,9 +63384,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -62858,8 +63410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-organization-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -62877,9 +63429,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -62904,8 +63456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -62923,9 +63475,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -62950,8 +63502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -62981,17 +63533,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63013,8 +63565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -63072,8 +63624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -63099,8 +63651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-variables parameters: - - *354 - - *355 + - *356 + - *357 - *180 - *19 responses: @@ -63118,9 +63670,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -63143,8 +63695,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#create-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -63196,17 +63748,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#get-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *413 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63227,8 +63779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#update-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 requestBody: required: true @@ -63271,8 +63823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#delete-a-repository-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 responses: '204': @@ -63294,8 +63846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -63332,8 +63884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *354 - - *355 + - *356 + - *357 - name: assignee in: path required: true @@ -63369,8 +63921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -63480,8 +64032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *47 - *48 @@ -63522,7 +64074,7 @@ paths: initiator: type: string examples: - default: *414 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63542,8 +64094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -63551,7 +64103,7 @@ paths: application/json: schema: type: array - items: &415 + items: &417 title: Autolink reference description: An autolink reference. type: object @@ -63605,8 +64157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -63645,9 +64197,9 @@ paths: description: response content: application/json: - schema: *415 + schema: *417 examples: - default: &416 + default: &418 value: id: 1 key_prefix: TICKET- @@ -63678,9 +64230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *354 - - *355 - - &417 + - *356 + - *357 + - &419 name: autolink_id description: The unique identifier of the autolink. in: path @@ -63692,9 +64244,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *417 examples: - default: *416 + default: *418 '404': *6 x-github: githubCloudOnly: false @@ -63714,9 +64266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *354 - - *355 - - *417 + - *356 + - *357 + - *419 responses: '204': description: Response @@ -63740,8 +64292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response if Dependabot is enabled @@ -63789,8 +64341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -63811,8 +64363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -63832,8 +64384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *354 - - *355 + - *356 + - *357 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -63871,7 +64423,7 @@ paths: - url protected: type: boolean - protection: &419 + protection: &421 title: Branch Protection description: Branch Protection type: object @@ -63913,7 +64465,7 @@ paths: required: - contexts - checks - enforce_admins: &422 + enforce_admins: &424 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -63928,7 +64480,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &424 + required_pull_request_reviews: &426 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -64004,7 +64556,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &421 + restrictions: &423 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -64281,9 +64833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *354 - - *355 - - &420 + - *356 + - *357 + - &422 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -64297,14 +64849,14 @@ paths: description: Response content: application/json: - schema: &430 + schema: &432 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &489 + commit: &491 title: Commit description: Commit type: object @@ -64338,7 +64890,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &418 + properties: &420 name: type: string example: '"Chris Wanstrath"' @@ -64354,7 +64906,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true message: type: string @@ -64375,7 +64927,7 @@ paths: required: - sha - url - verification: &542 + verification: &544 title: Verification type: object properties: @@ -64445,7 +64997,7 @@ paths: type: integer files: type: array - items: &502 + items: &504 title: Diff Entry description: Diff Entry type: object @@ -64529,7 +65081,7 @@ paths: - self protected: type: boolean - protection: *419 + protection: *421 protection_url: type: string format: uri @@ -64636,7 +65188,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *358 + '301': *360 '404': *6 x-github: githubCloudOnly: false @@ -64658,15 +65210,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *419 + schema: *421 examples: default: value: @@ -64860,9 +65412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -65117,7 +65669,7 @@ paths: url: type: string format: uri - required_status_checks: &427 + required_status_checks: &429 title: Status Check Policy description: Status Check Policy type: object @@ -65269,7 +65821,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *421 + restrictions: *423 required_conversation_resolution: type: object properties: @@ -65381,9 +65933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65408,17 +65960,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: &423 + default: &425 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -65440,17 +65992,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: *423 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65469,9 +66021,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65496,17 +66048,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: &425 + default: &427 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -65602,9 +66154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -65702,9 +66254,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: *425 + default: *427 '422': *15 x-github: githubCloudOnly: false @@ -65725,9 +66277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65754,17 +66306,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: &426 + default: &428 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -65787,17 +66339,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *422 + schema: *424 examples: - default: *426 + default: *428 '404': *6 x-github: githubCloudOnly: false @@ -65817,9 +66369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65844,17 +66396,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *427 + schema: *429 examples: - default: &428 + default: &430 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -65880,9 +66432,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -65934,9 +66486,9 @@ paths: description: Response content: application/json: - schema: *427 + schema: *429 examples: - default: *428 + default: *430 '404': *6 '422': *15 x-github: @@ -65958,9 +66510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -65984,9 +66536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66020,9 +66572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66089,9 +66641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66155,9 +66707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: content: application/json: @@ -66223,15 +66775,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response content: application/json: - schema: *421 + schema: *423 examples: default: value: @@ -66322,9 +66874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '204': description: Response @@ -66347,9 +66899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66359,7 +66911,7 @@ paths: type: array items: *5 examples: - default: &429 + default: &431 value: - id: 1 slug: octoapp @@ -66416,9 +66968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66452,7 +67004,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -66473,9 +67025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66509,7 +67061,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -66530,9 +67082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66566,7 +67118,7 @@ paths: type: array items: *5 examples: - default: *429 + default: *431 '422': *15 x-github: githubCloudOnly: false @@ -66588,9 +67140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66620,9 +67172,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66681,9 +67233,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: false content: @@ -66742,9 +67294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: content: application/json: @@ -66803,9 +67355,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 responses: '200': description: Response @@ -66839,9 +67391,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66899,9 +67451,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -66959,9 +67511,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67021,9 +67573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 requestBody: required: true content: @@ -67045,7 +67597,7 @@ paths: description: Response content: application/json: - schema: *430 + schema: *432 examples: default: value: @@ -67161,8 +67713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -67441,7 +67993,7 @@ paths: description: Response content: application/json: - schema: &431 + schema: &433 title: CheckRun description: A check performed on the code of a given code change type: object @@ -67561,7 +68113,7 @@ paths: check. type: array items: *93 - deployment: &782 + deployment: &797 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -67841,9 +68393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *354 - - *355 - - &432 + - *356 + - *357 + - &434 name: check_run_id description: The unique identifier of the check run. in: path @@ -67855,9 +68407,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *433 examples: - default: &433 + default: &435 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -67957,9 +68509,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 requestBody: required: true content: @@ -68199,9 +68751,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *433 examples: - default: *433 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68221,9 +68773,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 - *17 - *19 responses: @@ -68318,9 +68870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *354 - - *355 - - *432 + - *356 + - *357 + - *434 responses: '201': description: Response @@ -68364,8 +68916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -68387,7 +68939,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &436 + schema: &438 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -68473,12 +69025,12 @@ paths: type: string format: date-time nullable: true - head_commit: &810 + head_commit: &825 title: Simple Commit description: A commit. type: object - properties: *434 - required: *435 + properties: *436 + required: *437 latest_check_runs_count: type: integer check_runs_url: @@ -68506,7 +69058,7 @@ paths: - check_runs_url - pull_requests examples: - default: &437 + default: &439 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -68797,9 +69349,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *436 + schema: *438 examples: - default: *437 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68818,8 +69370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -69128,9 +69680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *354 - - *355 - - &438 + - *356 + - *357 + - &440 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -69142,9 +69694,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *438 examples: - default: *437 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69167,17 +69719,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *354 - - *355 - - *438 - - &495 + - *356 + - *357 + - *440 + - &497 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &496 + - &498 name: status description: Returns check runs with the specified `status`. in: query @@ -69216,9 +69768,9 @@ paths: type: integer check_runs: type: array - items: *431 + items: *433 examples: - default: &497 + default: &499 value: total_count: 1 check_runs: @@ -69320,9 +69872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *354 - - *355 - - *438 + - *356 + - *357 + - *440 responses: '201': description: Response @@ -69351,8 +69903,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *62 - *47 @@ -69374,7 +69926,7 @@ paths: application/json: schema: type: array - items: &439 + items: &441 description: Code quality finding type: object properties: @@ -69504,7 +70056,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': &440 + '403': &442 description: Response if the user is not authorized to access Code quality for this repository. content: @@ -69531,8 +70083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding parameters: - - *354 - - *355 + - *356 + - *357 - name: finding_number in: path description: The number that identifies a finding. @@ -69544,7 +70096,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *441 examples: default: value: @@ -69573,7 +70125,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': *440 + '403': *442 '404': *6 '503': *122 x-github: @@ -69595,8 +70147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -69660,7 +70212,7 @@ paths: runner_label: updated_at: '2023-01-01T00:00:00Z' schedule: weekly - '403': *440 + '403': *442 '404': *6 '503': *122 x-github: @@ -69681,8 +70233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -69810,21 +70362,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *354 - - *355 - - *441 - - *442 + - *356 + - *357 + - *443 + - *444 - *19 - *17 - - &459 + - &461 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *443 - - &460 + schema: *445 + - &462 name: pr description: The number of the pull request for the results you want to list. in: query @@ -69849,13 +70401,13 @@ paths: be returned. in: query required: false - schema: *444 + schema: *446 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *445 + schema: *447 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -69879,7 +70431,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *446 + instances_url: *448 state: *197 fixed_at: *193 dismissed_by: @@ -69890,11 +70442,11 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *447 - dismissed_comment: *448 - rule: *449 - tool: *450 - most_recent_instance: *451 + dismissed_reason: *449 + dismissed_comment: *450 + rule: *451 + tool: *452 + most_recent_instance: *453 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -70020,7 +70572,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &452 + '403': &454 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -70047,9 +70599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *354 - - *355 - - &453 + - *356 + - *357 + - &455 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -70063,7 +70615,7 @@ paths: description: Response content: application/json: - schema: &454 + schema: &456 type: object properties: number: *188 @@ -70071,7 +70623,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *446 + instances_url: *448 state: *197 fixed_at: *193 dismissed_by: @@ -70082,8 +70634,8 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *447 - dismissed_comment: *448 + dismissed_reason: *449 + dismissed_comment: *450 rule: type: object properties: @@ -70137,8 +70689,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *450 - most_recent_instance: *451 + tool: *452 + most_recent_instance: *453 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -70237,7 +70789,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -70257,9 +70809,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: true content: @@ -70274,8 +70826,8 @@ paths: enum: - open - dismissed - dismissed_reason: *447 - dismissed_comment: *448 + dismissed_reason: *449 + dismissed_comment: *450 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -70303,7 +70855,7 @@ paths: description: Response content: application/json: - schema: *454 + schema: *456 examples: default: value: @@ -70379,7 +70931,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &458 + '403': &460 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -70406,15 +70958,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 responses: '200': description: Response content: application/json: - schema: &455 + schema: &457 type: object properties: status: @@ -70440,13 +70992,13 @@ paths: - description - started_at examples: - default: &456 + default: &458 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &457 + '400': &459 description: Bad Request content: application/json: @@ -70457,7 +71009,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *452 + '403': *454 '404': *6 '500': *55 x-github: @@ -70482,29 +71034,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 responses: '200': description: OK content: application/json: - schema: *455 + schema: *457 examples: - default: *456 + default: *458 '202': description: Accepted content: application/json: - schema: *455 + schema: *457 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *457 + '400': *459 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -70536,9 +71088,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: false content: @@ -70583,8 +71135,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *457 - '403': *458 + '400': *459 + '403': *460 '404': *6 '422': description: Unprocessable Entity @@ -70608,13 +71160,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 - *19 - *17 - - *459 - - *460 + - *461 + - *462 responses: '200': description: Response @@ -70625,10 +71177,10 @@ paths: items: type: object properties: - ref: *443 - analysis_key: *461 - environment: *462 - category: *463 + ref: *445 + analysis_key: *463 + environment: *464 + category: *465 state: type: string description: State of a code scanning alert instance. @@ -70643,7 +71195,7 @@ paths: properties: text: type: string - location: *464 + location: *466 html_url: type: string classifications: @@ -70651,7 +71203,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *465 + items: *467 examples: default: value: @@ -70688,7 +71240,7 @@ paths: end_column: 50 classifications: - source - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -70722,25 +71274,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *354 - - *355 - - *441 - - *442 + - *356 + - *357 + - *443 + - *444 - *19 - *17 - - *460 + - *462 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *443 + schema: *445 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &466 + schema: &468 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -70761,23 +71313,23 @@ paths: application/json: schema: type: array - items: &467 + items: &469 type: object properties: - ref: *443 - commit_sha: &475 + ref: *445 + commit_sha: &477 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 64 pattern: "^([0-9a-fA-F]{40}(?:[0-9a-fA-F]{24})?)$" - analysis_key: *461 + analysis_key: *463 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *463 + category: *465 error: type: string example: error reading field xyz @@ -70801,8 +71353,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *466 - tool: *450 + sarif_id: *468 + tool: *452 deletable: type: boolean warning: @@ -70863,7 +71415,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -70899,8 +71451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -70913,7 +71465,7 @@ paths: description: Response content: application/json: - schema: *467 + schema: *469 examples: response: summary: application/json response @@ -70967,7 +71519,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *452 + '403': *454 '404': *6 '422': description: Response if analysis could not be processed @@ -71054,8 +71606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -71108,7 +71660,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *458 + '403': *460 '404': *6 '503': *122 x-github: @@ -71130,8 +71682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -71139,7 +71691,7 @@ paths: application/json: schema: type: array - items: &468 + items: &470 title: CodeQL Database description: A CodeQL database. type: object @@ -71250,7 +71802,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71279,8 +71831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: language in: path description: The language of the CodeQL database. @@ -71292,7 +71844,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *470 examples: default: value: @@ -71324,9 +71876,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &506 + '302': &508 description: Found - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -71348,8 +71900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *354 - - *355 + - *356 + - *357 - name: language in: path description: The language of the CodeQL database. @@ -71359,7 +71911,7 @@ paths: responses: '204': description: Response - '403': *458 + '403': *460 '404': *6 '503': *122 x-github: @@ -71387,8 +71939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -71397,7 +71949,7 @@ paths: type: object additionalProperties: false properties: - language: &469 + language: &471 type: string description: The language targeted by the CodeQL query enum: @@ -71477,7 +72029,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &473 + schema: &475 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -71487,7 +72039,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *469 + query_language: *471 query_pack_url: type: string description: The download url for the query pack. @@ -71534,7 +72086,7 @@ paths: items: type: object properties: - repository: &470 + repository: &472 title: Repository Identifier description: Repository Identifier type: object @@ -71570,7 +72122,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &474 + analysis_status: &476 type: string description: The new status of the CodeQL variant analysis repository task. @@ -71602,7 +72154,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &471 + access_mismatch_repos: &473 type: object properties: repository_count: @@ -71616,7 +72168,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *470 + items: *472 required: - repository_count - repositories @@ -71638,8 +72190,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *471 - over_limit_repos: *471 + no_codeql_db_repos: *473 + over_limit_repos: *473 required: - access_mismatch_repos - not_found_repos @@ -71655,7 +72207,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &472 + value: &474 summary: Default response value: id: 1 @@ -71801,10 +72353,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *472 + value: *474 repository_lists: summary: Response for a successful variant analysis submission - value: *472 + value: *474 '404': *6 '422': description: Unable to process variant analysis submission @@ -71832,8 +72384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *354 - - *355 + - *356 + - *357 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -71845,9 +72397,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: - default: *472 + default: *474 '404': *6 '503': *122 x-github: @@ -71870,7 +72422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *354 + - *356 - name: repo in: path description: The name of the controller repository. @@ -71905,7 +72457,7 @@ paths: type: object properties: repository: *67 - analysis_status: *474 + analysis_status: *476 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -72030,8 +72582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -72114,7 +72666,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *452 + '403': *454 '404': *6 '503': *122 x-github: @@ -72135,8 +72687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -72228,7 +72780,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *458 + '403': *460 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -72299,8 +72851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -72308,7 +72860,7 @@ paths: schema: type: object properties: - commit_sha: *475 + commit_sha: *477 ref: type: string description: |- @@ -72366,7 +72918,7 @@ paths: schema: type: object properties: - id: *466 + id: *468 url: type: string description: The REST API URL for checking the status of the upload. @@ -72380,7 +72932,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *458 + '403': *460 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -72403,8 +72955,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *354 - - *355 + - *356 + - *357 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -72450,7 +73002,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *452 + '403': *454 '404': description: Not Found if the sarif id does not match any upload '503': *122 @@ -72475,8 +73027,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -72557,8 +73109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -72678,8 +73230,8 @@ paths: parameters: - *17 - *19 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -72993,8 +73545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -73059,7 +73611,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -73067,7 +73619,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '400': *14 '401': *25 '403': *29 @@ -73096,8 +73648,8 @@ paths: parameters: - *17 - *19 - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -73161,8 +73713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -73197,14 +73749,14 @@ paths: type: integer machines: type: array - items: &723 + items: &738 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *477 - required: *478 + properties: *479 + required: *480 examples: - default: &724 + default: &739 value: total_count: 2 machines: @@ -73244,8 +73796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -73329,8 +73881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -73396,8 +73948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -73415,7 +73967,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &484 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -73435,7 +73987,7 @@ paths: - created_at - updated_at examples: - default: *479 + default: *481 headers: Link: *70 x-github: @@ -73458,16 +74010,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *480 + schema: *482 examples: - default: *481 + default: *483 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73487,17 +74039,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *482 + schema: *484 examples: - default: *483 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73517,8 +74069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -73571,8 +74123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -73601,8 +74153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *354 - - *355 + - *356 + - *357 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -73644,7 +74196,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &484 + properties: &486 login: type: string example: octocat @@ -73737,7 +74289,7 @@ paths: user_view_type: type: string example: public - required: &485 + required: &487 - avatar_url - events_url - followers_url @@ -73811,8 +74363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '204': @@ -73859,8 +74411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 requestBody: required: false @@ -73887,7 +74439,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &556 + schema: &558 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -74116,8 +74668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '204': @@ -74149,8 +74701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *354 - - *355 + - *356 + - *357 - *74 responses: '200': @@ -74171,8 +74723,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *484 - required: *485 + properties: *486 + required: *487 nullable: true required: - permission @@ -74227,8 +74779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -74238,7 +74790,7 @@ paths: application/json: schema: type: array - items: &486 + items: &488 title: Commit Comment description: Commit Comment type: object @@ -74296,7 +74848,7 @@ paths: - created_at - updated_at examples: - default: &491 + default: &493 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -74355,17 +74907,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *486 + schema: *488 examples: - default: &492 + default: &494 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -74422,8 +74974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -74446,7 +74998,7 @@ paths: description: Response content: application/json: - schema: *486 + schema: *488 examples: default: value: @@ -74497,8 +75049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -74520,8 +75072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -74548,7 +75100,7 @@ paths: application/json: schema: type: array - items: &487 + items: &489 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -74591,7 +75143,7 @@ paths: - content - created_at examples: - default: &561 + default: &563 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -74636,8 +75188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -74670,9 +75222,9 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: &488 + default: &490 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -74701,9 +75253,9 @@ paths: description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -74725,10 +75277,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - &562 + - &564 name: reaction_id description: The unique identifier of the reaction. in: path @@ -74783,8 +75335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *354 - - *355 + - *356 + - *357 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -74840,9 +75392,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: &629 + default: &631 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -74936,9 +75488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *354 - - *355 - - &490 + - *356 + - *357 + - &492 name: commit_sha description: The SHA of the commit. in: path @@ -75010,9 +75562,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 - *17 - *19 responses: @@ -75022,9 +75574,9 @@ paths: application/json: schema: type: array - items: *486 + items: *488 examples: - default: *491 + default: *493 headers: Link: *70 x-github: @@ -75052,9 +75604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 requestBody: required: true content: @@ -75089,9 +75641,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *488 examples: - default: *492 + default: *494 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75119,9 +75671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 - *17 - *19 responses: @@ -75131,9 +75683,9 @@ paths: application/json: schema: type: array - items: *493 + items: *495 examples: - default: &621 + default: &623 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -75670,11 +76222,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 - - &494 + - &496 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -75689,9 +76241,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *491 examples: - default: &608 + default: &610 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -75779,7 +76331,7 @@ paths: schema: type: string examples: - default: &503 + default: &505 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -75792,7 +76344,7 @@ paths: schema: type: string examples: - default: &504 + default: &506 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -75845,11 +76397,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *354 - - *355 - - *494 - - *495 + - *356 + - *357 - *496 + - *497 + - *498 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -75883,9 +76435,9 @@ paths: type: integer check_runs: type: array - items: *431 + items: *433 examples: - default: *497 + default: *499 headers: Link: *70 x-github: @@ -75910,9 +76462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -75920,7 +76472,7 @@ paths: schema: type: integer example: 1 - - *495 + - *497 - *17 - *19 responses: @@ -75938,7 +76490,7 @@ paths: type: integer check_suites: type: array - items: *436 + items: *438 examples: default: value: @@ -76138,9 +76690,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - *17 - *19 responses: @@ -76338,9 +76890,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *354 - - *355 - - *494 + - *356 + - *357 + - *496 - *17 - *19 responses: @@ -76350,7 +76902,7 @@ paths: application/json: schema: type: array - items: &702 + items: &717 title: Status description: The status of a commit. type: object @@ -76431,7 +76983,7 @@ paths: site_admin: false headers: Link: *70 - '301': *358 + '301': *360 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76459,8 +77011,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -76489,20 +77041,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *498 - required: *499 + properties: *500 + required: *501 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &500 + properties: &502 url: type: string format: uri html_url: type: string format: uri - required: &501 + required: &503 - url - html_url nullable: true @@ -76516,26 +77068,26 @@ paths: contributing: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true readme: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true issue_template: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true pull_request_template: title: Community Health File type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true required: - code_of_conduct @@ -76662,8 +77214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 - name: basehead @@ -76706,8 +77258,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *489 - merge_base_commit: *489 + base_commit: *491 + merge_base_commit: *491 status: type: string enum: @@ -76727,10 +77279,10 @@ paths: example: 6 commits: type: array - items: *489 + items: *491 files: type: array - items: *502 + items: *504 required: - url - html_url @@ -76976,12 +77528,12 @@ paths: schema: type: string examples: - default: *503 + default: *505 application/vnd.github.patch: schema: type: string examples: - default: *504 + default: *506 '404': *6 '500': *55 '503': *122 @@ -77026,8 +77578,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -77187,7 +77739,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &505 + response-if-content-is-a-file-github-object: &507 summary: Response if content is a file value: type: file @@ -77319,7 +77871,7 @@ paths: - size - type - url - - &634 + - &636 title: Content File description: Content File type: object @@ -77520,7 +78072,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *505 + response-if-content-is-a-file: *507 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -77589,7 +78141,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *506 + '302': *508 '304': *37 x-github: githubCloudOnly: false @@ -77612,8 +78164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -77706,7 +78258,7 @@ paths: description: Response content: application/json: - schema: &507 + schema: &509 title: File Commit description: File Commit type: object @@ -77858,7 +78410,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *509 examples: example-for-creating-a-file: value: @@ -77912,7 +78464,7 @@ paths: schema: oneOf: - *3 - - &537 + - &539 description: Repository rule violation was detected type: object properties: @@ -77933,7 +78485,7 @@ paths: items: type: object properties: - placeholder_id: &694 + placeholder_id: &709 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -77965,8 +78517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *354 - - *355 + - *356 + - *357 - name: path description: path parameter in: path @@ -78027,7 +78579,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *509 examples: default: value: @@ -78082,8 +78634,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *354 - - *355 + - *356 + - *357 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -78212,8 +78764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-cloud-agent-management#get-copilot-cloud-agent-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -78345,8 +78897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *212 - *213 - *214 @@ -78359,7 +78911,7 @@ paths: schema: type: string - *217 - - *508 + - *510 - *218 - *219 - *220 @@ -78374,7 +78926,7 @@ paths: application/json: schema: type: array - items: &512 + items: &514 type: object description: A Dependabot alert. properties: @@ -78421,7 +78973,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *509 + security_advisory: *511 security_vulnerability: *66 url: *191 html_url: *192 @@ -78452,8 +79004,8 @@ paths: nullable: true maxLength: 280 fixed_at: *193 - auto_dismissed_at: *510 - dismissal_request: *511 + auto_dismissed_at: *512 + dismissal_request: *513 assignees: type: array description: The users assigned to this alert. @@ -78708,9 +79260,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *354 - - *355 - - &513 + - *356 + - *357 + - &515 name: alert_number in: path description: |- @@ -78725,7 +79277,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -78857,9 +79409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *354 - - *355 - - *513 + - *356 + - *357 + - *515 requestBody: required: true content: @@ -78932,7 +79484,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -79062,8 +79614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -79081,7 +79633,7 @@ paths: type: integer secrets: type: array - items: &516 + items: &518 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -79134,16 +79686,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *514 + schema: *516 examples: - default: *515 + default: *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79163,15 +79715,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '200': description: Response content: application/json: - schema: *516 + schema: *518 examples: default: value: @@ -79197,8 +79749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 requestBody: required: true @@ -79251,8 +79803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *354 - - *355 + - *356 + - *357 - *171 responses: '204': @@ -79275,8 +79827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *354 - - *355 + - *356 + - *357 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -79439,8 +79991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -79678,8 +80230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: sbom_uuid in: path required: true @@ -79690,7 +80242,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *517 + Location: *519 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -79711,8 +80263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -79750,8 +80302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -79826,7 +80378,7 @@ paths: - version - url additionalProperties: false - metadata: &518 + metadata: &520 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -79859,7 +80411,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *518 + metadata: *520 resolved: type: object description: A collection of resolved package dependencies. @@ -79872,7 +80424,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *518 + metadata: *520 relationship: type: string description: A notation of whether a dependency is requested @@ -80001,8 +80553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *354 - - *355 + - *356 + - *357 - name: sha description: The SHA recorded at creation time. in: query @@ -80042,9 +80594,9 @@ paths: application/json: schema: type: array - items: *519 + items: *521 examples: - default: *520 + default: *522 headers: Link: *70 x-github: @@ -80110,8 +80662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -80192,7 +80744,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: simple-example: summary: Simple example @@ -80265,9 +80817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *354 - - *355 - - &521 + - *356 + - *357 + - &523 name: deployment_id description: deployment_id parameter in: path @@ -80279,7 +80831,7 @@ paths: description: Response content: application/json: - schema: *519 + schema: *521 examples: default: value: @@ -80344,9 +80896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 responses: '204': description: Response @@ -80368,9 +80920,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 - *17 - *19 responses: @@ -80380,7 +80932,7 @@ paths: application/json: schema: type: array - items: &522 + items: &524 title: Deployment Status description: The status of a deployment. type: object @@ -80541,9 +81093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 requestBody: required: true content: @@ -80618,9 +81170,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *524 examples: - default: &523 + default: &525 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -80676,9 +81228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *354 - - *355 - - *521 + - *356 + - *357 + - *523 - name: status_id in: path required: true @@ -80689,9 +81241,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *524 examples: - default: *523 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -80716,8 +81268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -80774,8 +81326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -80792,7 +81344,7 @@ paths: type: integer environments: type: array - items: &525 + items: &527 title: Environment description: Details of a deployment environment type: object @@ -80844,7 +81396,7 @@ paths: type: type: string example: wait_timer - wait_timer: &527 + wait_timer: &529 type: integer example: 30 description: The amount of time to delay a job after @@ -80881,7 +81433,7 @@ paths: items: type: object properties: - type: *524 + type: *526 reviewer: anyOf: - *4 @@ -80905,7 +81457,7 @@ paths: - id - node_id - type - deployment_branch_policy: &528 + deployment_branch_policy: &530 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -81021,9 +81573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *354 - - *355 - - &526 + - *356 + - *357 + - &528 name: environment_name in: path required: true @@ -81036,9 +81588,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: &529 + default: &531 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -81122,9 +81674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: false content: @@ -81133,7 +81685,7 @@ paths: type: object nullable: true properties: - wait_timer: *527 + wait_timer: *529 prevent_self_review: type: boolean example: false @@ -81150,13 +81702,13 @@ paths: items: type: object properties: - type: *524 + type: *526 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *528 + deployment_branch_policy: *530 additionalProperties: false examples: default: @@ -81176,9 +81728,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: *529 + default: *531 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -81202,9 +81754,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 responses: '204': description: Default response @@ -81229,9 +81781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *17 - *19 responses: @@ -81249,7 +81801,7 @@ paths: example: 2 branch_policies: type: array - items: &530 + items: &532 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -81306,9 +81858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: true content: @@ -81354,9 +81906,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - example-wildcard: &531 + example-wildcard: &533 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -81398,10 +81950,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - &532 + - *356 + - *357 + - *528 + - &534 name: branch_policy_id in: path required: true @@ -81413,9 +81965,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81434,10 +81986,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - *532 + - *356 + - *357 + - *528 + - *534 requestBody: required: true content: @@ -81465,9 +82017,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81486,10 +82038,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *354 - - *355 - - *526 - - *532 + - *356 + - *357 + - *528 + - *534 responses: '204': description: Response @@ -81514,9 +82066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 responses: '200': description: List of deployment protection rules @@ -81532,7 +82084,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &533 + items: &535 title: Deployment protection rule description: Deployment protection rule type: object @@ -81551,7 +82103,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &534 + app: &536 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -81650,9 +82202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 requestBody: content: application/json: @@ -81673,9 +82225,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *533 + schema: *535 examples: - default: &535 + default: &537 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -81710,9 +82262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *526 - - *355 - - *354 + - *528 + - *357 + - *356 - *19 - *17 responses: @@ -81731,7 +82283,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *534 + items: *536 examples: default: value: @@ -81766,10 +82318,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *354 - - *355 - - *526 - - &536 + - *356 + - *357 + - *528 + - &538 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -81781,9 +82333,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *535 examples: - default: *535 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81804,10 +82356,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *526 - - *355 - - *354 - - *536 + - *528 + - *357 + - *356 + - *538 responses: '204': description: Response @@ -81833,9 +82385,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *17 - *19 responses: @@ -81853,9 +82405,9 @@ paths: type: integer secrets: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -81880,9 +82432,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 responses: '200': description: Response @@ -81912,18 +82464,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 responses: '200': description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: *412 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81945,9 +82497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 requestBody: required: true @@ -82005,9 +82557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *171 responses: '204': @@ -82033,9 +82585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *180 - *19 responses: @@ -82053,9 +82605,9 @@ paths: type: integer variables: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -82078,9 +82630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 requestBody: required: true content: @@ -82132,18 +82684,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *354 - - *355 - - *526 + - *356 + - *357 + - *528 - *174 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *413 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82164,10 +82716,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 - - *526 + - *528 requestBody: required: true content: @@ -82209,10 +82761,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *354 - - *355 + - *356 + - *357 - *174 - - *526 + - *528 responses: '204': description: Response @@ -82234,8 +82786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -82303,8 +82855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *354 - - *355 + - *356 + - *357 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -82463,8 +83015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -82496,9 +83048,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 '400': *14 '422': *15 '403': *29 @@ -82519,8 +83071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -82580,7 +83132,7 @@ paths: schema: oneOf: - *132 - - *537 + - *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82605,8 +83157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *354 - - *355 + - *356 + - *357 - name: file_sha in: path required: true @@ -82705,8 +83257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -82815,7 +83367,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &540 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -83029,15 +83581,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *354 - - *355 - - *490 + - *356 + - *357 + - *492 responses: '200': description: Response content: application/json: - schema: *538 + schema: *540 examples: default: value: @@ -83093,9 +83645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *354 - - *355 - - &539 + - *356 + - *357 + - &541 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -83112,7 +83664,7 @@ paths: application/json: schema: type: array - items: &540 + items: &542 title: Git Reference description: Git references within a repository type: object @@ -83187,17 +83739,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 responses: '200': description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: &541 + default: &543 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -83226,8 +83778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83256,9 +83808,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: *541 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -83284,9 +83836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 requestBody: required: true content: @@ -83315,9 +83867,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *542 examples: - default: *541 + default: *543 '422': *15 '409': *54 x-github: @@ -83335,9 +83887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *354 - - *355 - - *539 + - *356 + - *357 + - *541 responses: '204': description: Response @@ -83392,8 +83944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83460,7 +84012,7 @@ paths: description: Response content: application/json: - schema: &543 + schema: &545 title: Git Tag description: Metadata for a Git tag type: object @@ -83511,7 +84063,7 @@ paths: - sha - type - url - verification: *542 + verification: *544 required: - sha - url @@ -83521,7 +84073,7 @@ paths: - tag - message examples: - default: &544 + default: &546 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -83594,8 +84146,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *354 - - *355 + - *356 + - *357 - name: tag_sha in: path required: true @@ -83606,9 +84158,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *545 examples: - default: *544 + default: *546 '404': *6 '409': *54 x-github: @@ -83632,8 +84184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -83706,7 +84258,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &547 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -83802,8 +84354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *354 - - *355 + - *356 + - *357 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -83826,7 +84378,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *547 examples: default-response: summary: Default response @@ -83884,8 +84436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-the-hash-algorithm-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -83928,8 +84480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -83939,7 +84491,7 @@ paths: application/json: schema: type: array - items: &546 + items: &548 title: Webhook description: Webhooks for repositories. type: object @@ -83993,7 +84545,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &818 + last_response: &833 title: Hook Response type: object properties: @@ -84067,8 +84619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -84120,9 +84672,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: &547 + default: &549 value: type: Repository id: 12345678 @@ -84170,17 +84722,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '200': description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '404': *6 x-github: githubCloudOnly: false @@ -84200,8 +84752,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 requestBody: required: true @@ -84247,9 +84799,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *548 examples: - default: *547 + default: *549 '422': *15 '404': *6 x-github: @@ -84270,8 +84822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84296,8 +84848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '200': @@ -84325,8 +84877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *230 requestBody: required: false @@ -84371,8 +84923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *17 - *231 @@ -84405,8 +84957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *16 responses: @@ -84435,8 +84987,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 - *16 responses: @@ -84460,8 +85012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84487,8 +85039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *354 - - *355 + - *356 + - *357 - *230 responses: '204': @@ -84512,8 +85064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response if immutable releases are enabled @@ -84559,8 +85111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '409': *54 @@ -84580,8 +85132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '409': *54 @@ -84638,14 +85190,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &548 + schema: &550 title: Import description: A repository import from an external source. type: object @@ -84744,7 +85296,7 @@ paths: - html_url - authors_url examples: - default: &551 + default: &553 value: vcs: subversion use_lfs: true @@ -84760,7 +85312,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &549 + '503': &551 description: Unavailable due to service under maintenance. content: application/json: @@ -84789,8 +85341,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -84838,7 +85390,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: default: value: @@ -84863,7 +85415,7 @@ paths: type: string '422': *15 '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84891,8 +85443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -84941,7 +85493,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: example-1: summary: Example 1 @@ -84989,7 +85541,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85012,12 +85564,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85043,9 +85595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *354 - - *355 - - &747 + - *356 + - *357 + - &762 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -85059,7 +85611,7 @@ paths: application/json: schema: type: array - items: &550 + items: &552 title: Porter Author description: Porter Author type: object @@ -85113,7 +85665,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85138,8 +85690,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *354 - - *355 + - *356 + - *357 - name: author_id in: path required: true @@ -85169,7 +85721,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *552 examples: default: value: @@ -85182,7 +85734,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85206,8 +85758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85248,7 +85800,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85276,8 +85828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -85304,11 +85856,11 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *551 + default: *553 '422': *15 - '503': *549 + '503': *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85331,8 +85883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85340,8 +85892,8 @@ paths: application/json: schema: *22 examples: - default: *552 - '301': *358 + default: *554 + '301': *360 '404': *6 x-github: githubCloudOnly: false @@ -85361,8 +85913,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85375,7 +85927,7 @@ paths: properties: {} additionalProperties: false examples: - default: &554 + default: &556 value: limit: collaborators_only origin: repository @@ -85400,13 +85952,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *553 + schema: *555 examples: default: summary: Example request body @@ -85420,7 +85972,7 @@ paths: application/json: schema: *249 examples: - default: *554 + default: *556 '409': description: Response x-github: @@ -85442,8 +85994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -85470,8 +86022,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85525,13 +86077,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#add-users-to-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: &555 + schema: &557 title: Interaction Limits Pull Request Bypass List description: A list of user logins to add or remove from the pull request creation cap bypass list. @@ -85581,13 +86133,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: application/json: - schema: *555 + schema: *557 examples: default: summary: Example request body @@ -85620,8 +86172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -85674,8 +86226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -85751,8 +86303,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -85762,9 +86314,9 @@ paths: application/json: schema: type: array - items: *556 + items: *558 examples: - default: &739 + default: &754 value: - id: 1 repository: @@ -85895,8 +86447,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *354 - - *355 + - *356 + - *357 - *253 requestBody: required: false @@ -85926,7 +86478,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *558 examples: default: value: @@ -86057,8 +86609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *354 - - *355 + - *356 + - *357 - *253 responses: '204': @@ -86082,8 +86634,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/issue-types#list-issue-types-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -86093,7 +86645,7 @@ paths: type: array items: *257 examples: - default: *557 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -86122,8 +86674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *354 - - *355 + - *356 + - *357 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -86210,7 +86762,7 @@ paths: type: array items: *88 examples: - default: &572 + default: &574 value: - id: 1 node_id: MDU6SXNzdWUx @@ -86359,7 +86911,7 @@ paths: state_reason: completed headers: Link: *70 - '301': *358 + '301': *360 '422': *15 '404': *6 x-github: @@ -86388,8 +86940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -86491,7 +87043,7 @@ paths: application/json: schema: *88 examples: - default: &569 + default: &571 value: id: 1 node_id: MDU6SXNzdWUx @@ -86629,7 +87181,7 @@ paths: '422': *15 '503': *122 '404': *6 - '410': *558 + '410': *560 x-github: triggersNotification: true githubCloudOnly: false @@ -86657,8 +87209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -86679,9 +87231,9 @@ paths: application/json: schema: type: array - items: *559 + items: *561 examples: - default: &571 + default: &573 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -86740,17 +87292,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: &560 + default: &562 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -86806,8 +87358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -86830,9 +87382,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *560 + default: *562 '422': *15 x-github: githubCloudOnly: false @@ -86850,8 +87402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -86880,15 +87432,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *559 + schema: *561 examples: default: value: @@ -86944,7 +87496,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -86961,8 +87513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -86970,7 +87522,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 '503': *122 x-github: githubCloudOnly: false @@ -86988,8 +87540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -87016,9 +87568,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -87039,8 +87591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -87073,16 +87625,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -87104,10 +87656,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - *562 + - *564 responses: '204': description: Response @@ -87127,8 +87679,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -87138,7 +87690,7 @@ paths: application/json: schema: type: array - items: &568 + items: &570 title: Issue Event description: Issue Event type: object @@ -87181,8 +87733,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *563 - required: *564 + properties: *565 + required: *566 nullable: true label: title: Issue Event Label @@ -87291,7 +87843,7 @@ paths: required: - from - to - issue_type: &565 + issue_type: &567 title: Issue Type description: The type of issue. type: object @@ -87319,14 +87871,14 @@ paths: required: - id - name - prev_issue_type: *565 + prev_issue_type: *567 sub_issue: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: &566 + properties: &568 number: type: integer description: The number of the referenced issue. @@ -87364,7 +87916,7 @@ paths: - id - node_id - name - required: &567 + required: &569 - number - title - state @@ -87376,24 +87928,24 @@ paths: event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 blocked_by: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 blocking: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 author_association: *85 lock_reason: type: string @@ -87593,8 +88145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *354 - - *355 + - *356 + - *357 - name: event_id in: path required: true @@ -87605,7 +88157,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *570 examples: default: value: @@ -87798,7 +88350,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *558 + '410': *560 '403': *29 x-github: githubCloudOnly: false @@ -87832,9 +88384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *354 - - *355 - - &570 + - *356 + - *357 + - &572 name: issue_number description: The number that identifies the issue. in: path @@ -87850,7 +88402,7 @@ paths: examples: default: summary: Issue - value: *569 + value: *571 pinned_comment: summary: Issue with pinned comment value: @@ -88030,9 +88582,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 '304': *37 x-github: githubCloudOnly: false @@ -88057,9 +88609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -88199,13 +88751,13 @@ paths: - type: object properties: {} examples: - default: *569 + default: *571 '422': *15 '503': *122 '403': *29 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88223,9 +88775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -88253,7 +88805,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88269,9 +88821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: content: application/json: @@ -88298,7 +88850,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88320,9 +88872,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: assignee in: path required: true @@ -88362,9 +88914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *95 - *17 - *19 @@ -88375,13 +88927,13 @@ paths: application/json: schema: type: array - items: *559 + items: *561 examples: - default: *571 + default: *573 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88410,9 +88962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -88434,16 +88986,16 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *560 + default: *562 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -88471,9 +89023,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -88485,12 +89037,12 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88518,9 +89070,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -88544,15 +89096,15 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *358 + '301': *360 '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -88583,9 +89135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -88599,13 +89151,13 @@ paths: application/json: schema: *88 examples: - default: *569 - '301': *358 + default: *571 + '301': *360 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *558 + '410': *560 x-github: triggersNotification: true githubCloudOnly: false @@ -88631,9 +89183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -88645,12 +89197,12 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88667,9 +89219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -88683,7 +89235,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &576 + - &578 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -88737,7 +89289,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &577 + - &579 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -88873,7 +89425,7 @@ paths: - performed_via_github_app - assignee - assigner - - &578 + - &580 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -88924,7 +89476,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &579 + - &581 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -88975,7 +89527,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &580 + - &582 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -89029,7 +89581,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &581 + - &583 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -89076,7 +89628,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &582 + - &584 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -89123,7 +89675,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &583 + - &585 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -89183,7 +89735,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &584 + - &586 title: Locked Issue Event description: Locked Issue Event type: object @@ -89231,7 +89783,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &585 + - &587 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -89297,7 +89849,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &586 + - &588 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -89363,7 +89915,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &587 + - &589 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -89429,7 +89981,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &588 + - &590 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -89485,7 +90037,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &593 + - &595 title: Issue Type Added Issue Event description: Issue Type Added Issue Event type: object @@ -89518,7 +90070,7 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *565 + issue_type: *567 required: - issue_type - id @@ -89530,7 +90082,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &594 + - &596 title: Issue Type Removed Issue Event description: Issue Type Removed Issue Event type: object @@ -89563,7 +90115,7 @@ paths: nullable: true properties: *83 required: *84 - prev_issue_type: *565 + prev_issue_type: *567 required: - prev_issue_type - id @@ -89575,7 +90127,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &595 + - &597 title: Issue Type Changed Issue Event description: Issue Type Changed Issue Event type: object @@ -89608,8 +90160,8 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *565 - prev_issue_type: *565 + issue_type: *567 + prev_issue_type: *567 required: - issue_type - prev_issue_type @@ -89622,7 +90174,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &596 + - &598 title: Sub-issue Added Issue Event description: Sub-issue Added Issue Event type: object @@ -89662,8 +90214,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - sub_issue - id @@ -89675,7 +90227,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &597 + - &599 title: Sub-issue Removed Issue Event description: Sub-issue Removed Issue Event type: object @@ -89715,8 +90267,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - sub_issue - id @@ -89728,7 +90280,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &598 + - &600 title: Parent-issue Added Issue Event description: Parent-issue Added Issue Event type: object @@ -89768,8 +90320,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - parent_issue - id @@ -89781,7 +90333,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &599 + - &601 title: Parent-issue Removed Issue Event description: Parent-issue Removed Issue Event type: object @@ -89821,8 +90373,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - parent_issue - id @@ -89834,7 +90386,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &600 + - &602 title: Blocked-by Added Issue Event description: Blocked-by Added Issue Event type: object @@ -89874,8 +90426,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocked_by - id @@ -89887,7 +90439,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &601 + - &603 title: Blocked-by Removed Issue Event description: Blocked-by Removed Issue Event type: object @@ -89927,8 +90479,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocked_by - id @@ -89940,7 +90492,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &602 + - &604 title: Blocking Added Issue Event description: Blocking Added Issue Event type: object @@ -89980,8 +90532,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocking - id @@ -89993,7 +90545,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &603 + - &605 title: Blocking Removed Issue Event description: Blocking Removed Issue Event type: object @@ -90033,8 +90585,8 @@ paths: events). type: object nullable: true - properties: *566 - required: *567 + properties: *568 + required: *569 required: - blocking - id @@ -90081,7 +90633,7 @@ paths: color: red headers: Link: *70 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90098,9 +90650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -90110,9 +90662,9 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: &574 + default: &576 value: - issue_field_id: 1 issue_field_name: DRI @@ -90152,9 +90704,9 @@ paths: color: green headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90183,9 +90735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90255,9 +90807,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *573 + items: *575 examples: - default: *574 + default: *576 '400': *14 '403': *29 '404': *6 @@ -90293,9 +90845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90360,9 +90912,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *573 + items: *575 examples: - default: *574 + default: *576 '400': *14 '403': *29 '404': *6 @@ -90393,9 +90945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *256 responses: '204': @@ -90421,9 +90973,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -90435,7 +90987,7 @@ paths: type: array items: *87 examples: - default: &575 + default: &577 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -90453,9 +91005,9 @@ paths: default: false headers: Link: *70 - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90471,9 +91023,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -90518,10 +91070,10 @@ paths: type: array items: *87 examples: - default: *575 - '301': *358 + default: *577 + '301': *360 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -90538,9 +91090,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -90602,10 +91154,10 @@ paths: type: array items: *87 examples: - default: *575 - '301': *358 + default: *577 + '301': *360 '404': *6 - '410': *558 + '410': *560 '422': *15 x-github: githubCloudOnly: false @@ -90622,15 +91174,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '204': description: Response - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90649,9 +91201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: name in: path required: true @@ -90675,9 +91227,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *358 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90697,9 +91249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: false content: @@ -90727,7 +91279,7 @@ paths: '204': description: Response '403': *29 - '410': *558 + '410': *560 '404': *6 '422': *15 x-github: @@ -90745,9 +91297,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '204': description: Response @@ -90777,9 +91329,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 responses: '200': description: Response @@ -90787,10 +91339,10 @@ paths: application/json: schema: *88 examples: - default: *569 - '301': *358 + default: *571 + '301': *360 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90807,9 +91359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -90835,13 +91387,13 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90859,9 +91411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90893,16 +91445,16 @@ paths: description: Response content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Response content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -90924,10 +91476,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *354 - - *355 - - *570 - - *562 + - *356 + - *357 + - *572 + - *564 responses: '204': description: Response @@ -90956,9 +91508,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -90982,7 +91534,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -91015,9 +91567,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -91029,11 +91581,11 @@ paths: type: array items: *88 examples: - default: *572 + default: *574 headers: Link: *70 '404': *6 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91061,9 +91613,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91092,14 +91644,14 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *558 + '410': *560 '422': *15 '404': *6 x-github: @@ -91119,9 +91671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 requestBody: required: true content: @@ -91154,7 +91706,7 @@ paths: application/json: schema: *88 examples: - default: *569 + default: *571 '403': *29 '404': *6 '422': *7 @@ -91176,9 +91728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *354 - - *355 - - *570 + - *356 + - *357 + - *572 - *17 - *19 responses: @@ -91193,8 +91745,6 @@ paths: description: Timeline Event type: object anyOf: - - *576 - - *577 - *578 - *579 - *580 @@ -91206,6 +91756,8 @@ paths: - *586 - *587 - *588 + - *589 + - *590 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -91266,15 +91818,15 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true required: - event @@ -91529,7 +92081,7 @@ paths: type: string comments: type: array - items: &623 + items: &625 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -91744,7 +92296,7 @@ paths: type: string comments: type: array - items: *486 + items: *488 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -91878,8 +92430,6 @@ paths: - commit_url - created_at - performed_via_github_app - - *593 - - *594 - *595 - *596 - *597 @@ -91889,6 +92439,8 @@ paths: - *601 - *602 - *603 + - *604 + - *605 examples: default: value: @@ -92045,7 +92597,7 @@ paths: Link: *70 '404': *6 '400': *14 - '410': *558 + '410': *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92062,8 +92614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -92073,7 +92625,7 @@ paths: application/json: schema: type: array - items: &604 + items: &606 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -92139,8 +92691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92176,9 +92728,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: &605 + default: &607 value: id: 1 key: ssh-rsa AAA... @@ -92212,9 +92764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *354 - - *355 - - &606 + - *356 + - *357 + - &608 name: key_id description: The unique identifier of the key. in: path @@ -92226,9 +92778,9 @@ paths: description: Response content: application/json: - schema: *604 + schema: *606 examples: - default: *605 + default: *607 '404': *6 x-github: githubCloudOnly: false @@ -92246,9 +92798,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *354 - - *355 - - *606 + - *356 + - *357 + - *608 responses: '204': description: Response @@ -92268,8 +92820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -92281,7 +92833,7 @@ paths: type: array items: *87 examples: - default: *575 + default: *577 headers: Link: *70 '404': *6 @@ -92302,8 +92854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92341,7 +92893,7 @@ paths: application/json: schema: *87 examples: - default: &607 + default: &609 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92373,8 +92925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92387,7 +92939,7 @@ paths: application/json: schema: *87 examples: - default: *607 + default: *609 '404': *6 x-github: githubCloudOnly: false @@ -92404,8 +92956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92470,8 +93022,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *354 - - *355 + - *356 + - *357 - name: name in: path required: true @@ -92497,8 +93049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -92537,9 +93089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *354 - - *355 - - *459 + - *356 + - *357 + - *461 responses: '200': description: Response @@ -92684,8 +93236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92750,8 +93302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92785,9 +93337,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *489 + schema: *491 examples: - default: *608 + default: *610 '204': description: Response when already merged '404': @@ -92812,8 +93364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *354 - - *355 + - *356 + - *357 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -92854,7 +93406,7 @@ paths: application/json: schema: type: array - items: &609 + items: &611 title: Milestone description: A collection of related issues and pull requests. type: object @@ -92915,8 +93467,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -92956,9 +93508,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: &610 + default: &612 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -93017,9 +93569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *354 - - *355 - - &611 + - *356 + - *357 + - &613 name: milestone_number description: The number that identifies the milestone. in: path @@ -93031,9 +93583,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: *610 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -93050,9 +93602,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 requestBody: required: false content: @@ -93090,9 +93642,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *611 examples: - default: *610 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93108,9 +93660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 responses: '204': description: Response @@ -93131,9 +93683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *354 - - *355 - - *611 + - *356 + - *357 + - *613 - *17 - *19 responses: @@ -93145,7 +93697,7 @@ paths: type: array items: *87 examples: - default: *575 + default: *577 headers: Link: *70 x-github: @@ -93164,12 +93716,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *354 - - *355 - - *612 - - *613 - - *95 + - *356 + - *357 - *614 + - *615 + - *95 + - *616 - *17 - *19 responses: @@ -93181,7 +93733,7 @@ paths: type: array items: *115 examples: - default: *615 + default: *617 headers: Link: *70 x-github: @@ -93205,8 +93757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -93264,14 +93816,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: &616 + schema: &618 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -93396,7 +93948,7 @@ paths: - custom_404 - public examples: - default: &617 + default: &619 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -93437,8 +93989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93492,9 +94044,9 @@ paths: description: Response content: application/json: - schema: *616 + schema: *618 examples: - default: *617 + default: *619 '422': *15 '409': *54 x-github: @@ -93517,8 +94069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93617,8 +94169,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -93644,8 +94196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -93655,7 +94207,7 @@ paths: application/json: schema: type: array - items: &618 + items: &620 title: Page Build description: Page Build type: object @@ -93749,8 +94301,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *354 - - *355 + - *356 + - *357 responses: '201': description: Response @@ -93795,16 +94347,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *618 + schema: *620 examples: - default: &619 + default: &621 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -93852,8 +94404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *354 - - *355 + - *356 + - *357 - name: build_id in: path required: true @@ -93864,9 +94416,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *620 examples: - default: *619 + default: *621 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93886,8 +94438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -93992,9 +94544,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *354 - - *355 - - &620 + - *356 + - *357 + - &622 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -94052,9 +94604,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *354 - - *355 - - *620 + - *356 + - *357 + - *622 responses: '204': *61 '404': *6 @@ -94081,8 +94633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -94340,8 +94892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Private vulnerability reporting status @@ -94378,8 +94930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '422': *14 @@ -94400,8 +94952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': *61 '422': *14 @@ -94423,8 +94975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -94463,8 +95015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -94526,8 +95078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *354 - - *355 + - *356 + - *357 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -94587,9 +95139,9 @@ paths: application/json: schema: type: array - items: *493 + items: *495 examples: - default: *621 + default: *623 headers: Link: *70 '304': *37 @@ -94621,8 +95173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -94687,7 +95239,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &627 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -94831,7 +95383,7 @@ paths: items: *4 requested_teams: type: array - items: *346 + items: *348 head: type: object properties: @@ -94887,7 +95439,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: *622 + auto_merge: *624 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -94977,7 +95529,7 @@ paths: - merged_by - review_comments examples: - default: &626 + default: &628 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -95484,8 +96036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *354 - - *355 + - *356 + - *357 - name: sort in: query required: false @@ -95514,9 +96066,9 @@ paths: application/json: schema: type: array - items: *623 + items: *625 examples: - default: &628 + default: &630 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95593,17 +96145,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '200': description: Response content: application/json: - schema: *623 + schema: *625 examples: - default: &624 + default: &626 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -95678,8 +96230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -95702,9 +96254,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: - default: *624 + default: *626 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95720,8 +96272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 + - *356 + - *357 - *104 responses: '204': @@ -95743,8 +96295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -95771,9 +96323,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -95794,8 +96346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *354 - - *355 + - *356 + - *357 - *104 requestBody: required: true @@ -95828,16 +96380,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -95859,10 +96411,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *354 - - *355 + - *356 + - *357 - *104 - - *562 + - *564 responses: '204': description: Response @@ -95905,9 +96457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *354 - - *355 - - &627 + - *356 + - *357 + - &629 name: pull_number description: The number that identifies the pull request. in: path @@ -95920,9 +96472,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *625 + schema: *627 examples: - default: *626 + default: *628 '304': *37 '404': *6 '406': @@ -95957,9 +96509,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -96001,9 +96553,9 @@ paths: description: Response content: application/json: - schema: *625 + schema: *627 examples: - default: *626 + default: *628 '422': *15 '403': *29 x-github: @@ -96025,9 +96577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -96089,7 +96641,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -96097,7 +96649,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -96127,9 +96679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -96150,9 +96702,9 @@ paths: application/json: schema: type: array - items: *623 + items: *625 examples: - default: *628 + default: *630 headers: Link: *70 x-github: @@ -96185,9 +96737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -96292,7 +96844,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: example-for-a-multi-line-comment: value: @@ -96380,9 +96932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *104 requestBody: required: true @@ -96405,7 +96957,7 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: default: value: @@ -96491,9 +97043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -96503,9 +97055,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *629 + default: *631 headers: Link: *70 x-github: @@ -96535,9 +97087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -96547,7 +97099,7 @@ paths: application/json: schema: type: array - items: *502 + items: *504 examples: default: value: @@ -96585,9 +97137,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 responses: '204': description: Response if pull request has been merged @@ -96610,9 +97162,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -96723,9 +97275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 responses: '200': description: Response @@ -96800,9 +97352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -96839,7 +97391,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *495 examples: default: value: @@ -97375,9 +97927,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: true content: @@ -97411,7 +97963,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *495 examples: default: value: @@ -97896,9 +98448,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 - *17 - *19 responses: @@ -97908,7 +98460,7 @@ paths: application/json: schema: type: array - items: &630 + items: &632 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -98059,9 +98611,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -98147,9 +98699,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: &632 + default: &634 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98212,10 +98764,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - &631 + - *356 + - *357 + - *629 + - &633 name: review_id description: The unique identifier of the review. in: path @@ -98227,9 +98779,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: &633 + default: &635 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -98288,10 +98840,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -98314,7 +98866,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: default: value: @@ -98376,18 +98928,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 responses: '200': description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: *632 + default: *634 '422': *7 '404': *6 x-github: @@ -98414,10 +98966,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 - *17 - *19 responses: @@ -98652,10 +99204,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -98683,7 +99235,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: default: value: @@ -98746,10 +99298,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *354 - - *355 - - *627 - - *631 + - *356 + - *357 + - *629 + - *633 requestBody: required: true content: @@ -98784,9 +99336,9 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: - default: *633 + default: *635 '404': *6 '422': *7 '403': *29 @@ -98808,9 +99360,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *354 - - *355 - - *627 + - *356 + - *357 + - *629 requestBody: required: false content: @@ -98873,8 +99425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *354 - - *355 + - *356 + - *357 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -98887,9 +99439,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: &635 + default: &637 value: type: file encoding: base64 @@ -98931,8 +99483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *354 - - *355 + - *356 + - *357 - name: dir description: The alternate path to look for a README file in: path @@ -98952,9 +99504,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: *635 + default: *637 '404': *6 '422': *15 x-github: @@ -98976,8 +99528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -98987,7 +99539,7 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: default: value: @@ -99081,8 +99633,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -99158,9 +99710,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: &640 + default: &642 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -99265,9 +99817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *354 - - *355 - - &638 + - *356 + - *357 + - &640 name: asset_id description: The unique identifier of the asset. in: path @@ -99279,9 +99831,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: &639 + default: &641 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -99316,7 +99868,7 @@ paths: type: User site_admin: false '404': *6 - '302': *506 + '302': *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99332,9 +99884,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *354 - - *355 - - *638 + - *356 + - *357 + - *640 requestBody: required: false content: @@ -99362,9 +99914,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99380,9 +99932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *354 - - *355 - - *638 + - *356 + - *357 + - *640 responses: '204': description: Response @@ -99407,8 +99959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -99493,16 +100045,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -99520,8 +100072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *354 - - *355 + - *356 + - *357 - name: tag description: tag parameter in: path @@ -99534,9 +100086,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -99558,9 +100110,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *354 - - *355 - - &641 + - *356 + - *357 + - &643 name: release_id description: The unique identifier of the release. in: path @@ -99574,9 +100126,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '401': description: Unauthorized x-github: @@ -99594,9 +100146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 requestBody: required: false content: @@ -99660,9 +100212,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *640 + default: *642 '404': description: Not Found if the discussion category name is invalid content: @@ -99683,9 +100235,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 responses: '204': description: Response @@ -99706,9 +100258,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - *17 - *19 responses: @@ -99718,7 +100270,7 @@ paths: application/json: schema: type: array - items: *637 + items: *639 examples: default: value: @@ -99799,9 +100351,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - name: name in: query required: true @@ -99827,7 +100379,7 @@ paths: description: Response for successful upload content: application/json: - schema: *637 + schema: *639 examples: response-for-successful-upload: value: @@ -99882,9 +100434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -99908,9 +100460,9 @@ paths: application/json: schema: type: array - items: *487 + items: *489 examples: - default: *561 + default: *563 headers: Link: *70 '404': *6 @@ -99931,9 +100483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *354 - - *355 - - *641 + - *356 + - *357 + - *643 requestBody: required: true content: @@ -99963,16 +100515,16 @@ paths: description: Reaction exists content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '201': description: Reaction created content: application/json: - schema: *487 + schema: *489 examples: - default: *488 + default: *490 '422': *15 x-github: githubCloudOnly: false @@ -99994,10 +100546,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *354 - - *355 - - *641 - - *562 + - *356 + - *357 + - *643 + - *564 responses: '204': description: Response @@ -100021,9 +100573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *354 - - *355 - - *420 + - *356 + - *357 + - *422 - *17 - *19 responses: @@ -100040,7 +100592,7 @@ paths: oneOf: - allOf: - *318 - - &642 + - &644 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -100061,70 +100613,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *319 - - *642 + - *644 - allOf: - *320 - - *642 + - *644 - allOf: - *321 - - *642 + - *644 - allOf: - - *643 - - *642 + - *645 + - *644 - allOf: - *322 - - *642 + - *644 - allOf: - *323 - - *642 + - *644 - allOf: - *324 - - *642 + - *644 - allOf: - *325 - - *642 + - *644 - allOf: - *326 - - *642 + - *644 - allOf: - *327 - - *642 + - *644 - allOf: - *328 - - *642 + - *644 - allOf: - *329 - - *642 + - *644 - allOf: - *330 - - *642 + - *644 - allOf: - *331 - - *642 + - *644 - allOf: - *336 - - *642 + - *644 - allOf: - *337 - - *642 + - *644 - allOf: - *338 - - *642 + - *644 - allOf: + - *646 - *644 - - *642 - allOf: - *332 - - *642 + - *644 - allOf: - *333 - - *642 + - *644 - allOf: - *334 - - *642 + - *644 - allOf: - *335 - - *642 + - *644 examples: default: value: @@ -100163,8 +100715,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - name: includes_parents @@ -100175,7 +100727,7 @@ paths: schema: type: boolean default: true - - *645 + - *647 responses: '200': description: Response @@ -100230,8 +100782,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 requestBody: description: Request body required: true @@ -100260,7 +100812,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *646 + items: *648 required: - name - enforcement @@ -100293,7 +100845,7 @@ paths: application/json: schema: *339 examples: - default: &657 + default: &659 value: id: 42 name: super cool ruleset @@ -100341,13 +100893,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *354 - - *355 - - *647 - - *648 + - *356 + - *357 - *649 - *650 - *651 + - *652 + - *653 - *17 - *19 responses: @@ -100355,9 +100907,9 @@ paths: description: Response content: application/json: - schema: *652 + schema: *654 examples: - default: *653 + default: *655 '404': *6 '500': *55 x-github: @@ -100378,17 +100930,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *354 - - *355 - - *654 + - *356 + - *357 + - *656 responses: '200': description: Response content: application/json: - schema: *655 + schema: *657 examples: - default: *656 + default: *658 '404': *6 '500': *55 x-github: @@ -100416,8 +100968,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100439,7 +100991,7 @@ paths: application/json: schema: *339 examples: - default: *657 + default: *659 '404': *6 '500': *55 put: @@ -100457,8 +101009,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100492,7 +101044,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *646 + items: *648 examples: default: value: @@ -100522,7 +101074,7 @@ paths: application/json: schema: *339 examples: - default: *657 + default: *659 '404': *6 '422': *15 '500': *55 @@ -100541,8 +101093,8 @@ paths: category: repos subcategory: rules parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100565,8 +101117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 - name: ruleset_id @@ -100584,7 +101136,7 @@ paths: type: array items: *342 examples: - default: *658 + default: *660 '404': *6 '500': *55 x-github: @@ -100603,8 +101155,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *354 - - *355 + - *356 + - *357 - name: ruleset_id description: The ID of the ruleset. in: path @@ -100622,7 +101174,7 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: default: value: @@ -100677,21 +101229,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *354 - - *355 - - *660 - - *661 + - *356 + - *357 - *662 - *663 - *664 - *665 - *666 - *667 + - *668 + - *669 - *62 - *19 - *17 - - *668 - - *669 - *670 - *671 - *672 @@ -100699,6 +101249,8 @@ paths: - *674 - *675 - *676 + - *677 + - *678 responses: '200': description: Response @@ -100725,8 +101277,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolved_at: type: string format: date-time @@ -100832,7 +101384,7 @@ paths: pull request. ' - oneOf: *679 + oneOf: *681 nullable: true has_more_locations: type: boolean @@ -100996,16 +101548,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 - - *673 + - *356 + - *357 + - *455 + - *675 responses: '200': description: Response content: application/json: - schema: &680 + schema: &682 type: object properties: number: *188 @@ -101023,8 +101575,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolved_at: type: string format: date-time @@ -101130,7 +101682,7 @@ paths: pull request. ' - oneOf: *679 + oneOf: *681 nullable: true has_more_locations: type: boolean @@ -101158,7 +101710,7 @@ paths: properties: *20 required: *21 nullable: true - metadata: &839 + metadata: &854 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -101231,9 +101783,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 requestBody: required: true content: @@ -101241,8 +101793,8 @@ paths: schema: type: object properties: - state: *677 - resolution: *678 + state: *679 + resolution: *680 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -101286,7 +101838,7 @@ paths: description: Response content: application/json: - schema: *680 + schema: *682 examples: default: value: @@ -101388,9 +101940,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *354 - - *355 - - *453 + - *356 + - *357 + - *455 - *19 - *17 responses: @@ -101401,7 +101953,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &841 + items: &856 type: object properties: type: @@ -101427,8 +101979,6 @@ paths: example: commit details: oneOf: - - *681 - - *682 - *683 - *684 - *685 @@ -101440,6 +101990,8 @@ paths: - *691 - *692 - *693 + - *694 + - *695 examples: default: value: @@ -101509,6 +102061,221 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + - *696 + - *697 + - *698 + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *343 + examples: + default: *699 + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: *700 + examples: + default: *701 + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *343 + examples: + default: *702 + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: *703 + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: *704 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: *705 + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': *345 + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *356 + - *357 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: *706 + examples: + default: *707 + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *343 + examples: + default: *708 + '400': *14 + '403': *29 + '404': *6 + '412': *345 + '422': *15 "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -101525,8 +102292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -101534,14 +102301,14 @@ paths: schema: type: object properties: - reason: &695 + reason: &710 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *694 + placeholder_id: *709 required: - reason - placeholder_id @@ -101558,7 +102325,7 @@ paths: schema: type: object properties: - reason: *695 + reason: *710 expire_at: type: string format: date-time @@ -101604,8 +102371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -101620,7 +102387,7 @@ paths: properties: incremental_scans: type: array - items: &696 + items: &711 description: Information on a single scan performed by secret scanning on the repository type: object @@ -101651,15 +102418,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *696 + items: *711 backfill_scans: type: array - items: *696 + items: *711 custom_pattern_backfill_scans: type: array items: allOf: - - *696 + - *711 - type: object properties: pattern_name: @@ -101672,7 +102439,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *696 + items: *711 examples: default: value: @@ -101737,8 +102504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *354 - - *355 + - *356 + - *357 - *62 - name: sort description: The property to sort the results by. @@ -101782,9 +102549,9 @@ paths: application/json: schema: type: array - items: *697 + items: *712 examples: - default: *698 + default: *713 '400': *14 '404': *6 x-github: @@ -101807,8 +102574,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -101881,7 +102648,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 required: - login - type @@ -101968,9 +102735,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: &700 + default: &715 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -102200,8 +102967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -102305,7 +103072,7 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: default: value: @@ -102451,17 +103218,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '200': description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: *700 + default: *715 '403': *29 '404': *6 x-github: @@ -102485,9 +103252,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 requestBody: required: true content: @@ -102560,7 +103327,7 @@ paths: login: type: string description: The username of the user credited. - type: *345 + type: *347 required: - login - type @@ -102646,10 +103413,10 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: *700 - add_credit: *700 + default: *715 + add_credit: *715 '403': *29 '404': *6 '422': @@ -102687,9 +103454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '202': *39 '400': *14 @@ -102716,17 +103483,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *354 - - *355 - - *699 + - *356 + - *357 + - *714 responses: '202': description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 '400': *14 '422': *15 '403': *29 @@ -102752,8 +103519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -102852,8 +103619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -102862,7 +103629,7 @@ paths: application/json: schema: type: array - items: &701 + items: &716 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -102895,8 +103662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -102972,8 +103739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -103069,8 +103836,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -103224,8 +103991,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -103235,7 +104002,7 @@ paths: application/json: schema: type: array - items: *701 + items: *716 examples: default: value: @@ -103268,8 +104035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *354 - - *355 + - *356 + - *357 - name: sha in: path required: true @@ -103323,7 +104090,7 @@ paths: description: Response content: application/json: - schema: *702 + schema: *717 examples: default: value: @@ -103377,8 +104144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -103410,14 +104177,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &703 + schema: &718 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -103485,8 +104252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: false content: @@ -103512,7 +104279,7 @@ paths: description: Response content: application/json: - schema: *703 + schema: *718 examples: default: value: @@ -103539,8 +104306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -103560,8 +104327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -103640,8 +104407,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *354 - - *355 + - *356 + - *357 - name: ref in: path required: true @@ -103677,8 +104444,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *354 - - *355 + - *356 + - *357 - *17 - *19 responses: @@ -103710,8 +104477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *354 - - *355 + - *356 + - *357 - *19 - *17 responses: @@ -103719,7 +104486,7 @@ paths: description: Response content: application/json: - schema: &704 + schema: &719 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -103731,7 +104498,7 @@ paths: required: - names examples: - default: &705 + default: &720 value: names: - octocat @@ -103754,8 +104521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -103786,9 +104553,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *719 examples: - default: *705 + default: *720 '404': *6 '422': *7 x-github: @@ -103809,9 +104576,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *354 - - *355 - - &706 + - *356 + - *357 + - &721 name: per description: The time frame to display results for. in: query @@ -103840,7 +104607,7 @@ paths: example: 128 clones: type: array - items: &707 + items: &722 title: Traffic type: object properties: @@ -103927,8 +104694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -104018,8 +104785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *354 - - *355 + - *356 + - *357 responses: '200': description: Response @@ -104079,9 +104846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *354 - - *355 - - *706 + - *356 + - *357 + - *721 responses: '200': description: Response @@ -104100,7 +104867,7 @@ paths: example: 3782 views: type: array - items: *707 + items: *722 required: - uniques - count @@ -104177,8 +104944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *354 - - *355 + - *356 + - *357 requestBody: required: true content: @@ -104451,8 +105218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -104475,8 +105242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -104498,8 +105265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -104525,8 +105292,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *354 - - *355 + - *356 + - *357 - name: ref in: path required: true @@ -104618,9 +105385,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -104871,7 +105638,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &708 + text_matches: &723 title: Search Result Text Matches type: array items: @@ -105033,7 +105800,7 @@ paths: enum: - author-date - committer-date - - &709 + - &724 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -105104,7 +105871,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true comment_count: type: integer @@ -105124,7 +105891,7 @@ paths: url: type: string format: uri - verification: *542 + verification: *544 required: - author - committer @@ -105143,7 +105910,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *418 + properties: *420 nullable: true parents: type: array @@ -105161,7 +105928,7 @@ paths: type: number node_id: type: string - text_matches: *708 + text_matches: *723 required: - sha - node_id @@ -105353,7 +106120,7 @@ paths: - interactions - created - updated - - *709 + - *724 - *17 - *19 - name: advanced_search @@ -105467,11 +106234,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: type: string state_reason: @@ -105496,7 +106263,7 @@ paths: type: string format: date-time nullable: true - text_matches: *708 + text_matches: *723 pull_request: type: object properties: @@ -105776,7 +106543,7 @@ paths: enum: - created - updated - - *709 + - *724 - *17 - *19 responses: @@ -105820,7 +106587,7 @@ paths: nullable: true score: type: number - text_matches: *708 + text_matches: *723 required: - id - node_id @@ -105905,7 +106672,7 @@ paths: - forks - help-wanted-issues - updated - - *709 + - *724 - *17 - *19 responses: @@ -106153,7 +106920,7 @@ paths: - admin - pull - push - text_matches: *708 + text_matches: *723 temp_clone_token: type: string allow_merge_commit: @@ -106453,7 +107220,7 @@ paths: type: string format: uri nullable: true - text_matches: *708 + text_matches: *723 related: type: array nullable: true @@ -106644,7 +107411,7 @@ paths: - followers - repositories - joined - - *709 + - *724 - *17 - *19 responses: @@ -106748,7 +107515,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *708 + text_matches: *723 blog: type: string nullable: true @@ -106827,7 +107594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &712 + - &727 name: team_id description: The unique identifier of the team. in: path @@ -106839,9 +107606,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 x-github: githubCloudOnly: false @@ -106868,7 +107635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *712 + - *727 requestBody: required: true content: @@ -106931,16 +107698,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '201': description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 '404': *6 '422': *15 '403': *29 @@ -106968,7 +107735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *712 + - *727 responses: '204': description: Response @@ -106997,7 +107764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -107037,7 +107804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *712 + - *727 - name: role description: Filters members returned by their role in the team. in: query @@ -107058,9 +107825,9 @@ paths: application/json: schema: type: array - items: *713 + items: *728 examples: - default: *714 + default: *729 headers: Link: *70 '404': *6 @@ -107088,7 +107855,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107125,7 +107892,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107165,7 +107932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107202,16 +107969,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 responses: '200': description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-user-is-a-team-maintainer: *715 + response-if-user-is-a-team-maintainer: *730 '404': *6 x-github: githubCloudOnly: false @@ -107244,7 +108011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 requestBody: required: false @@ -107270,9 +108037,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *355 examples: - response-if-users-membership-with-team-is-now-pending: *716 + response-if-users-membership-with-team-is-now-pending: *731 '403': description: Forbidden if team synchronization is set up '422': @@ -107306,7 +108073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *712 + - *727 - *74 responses: '204': @@ -107334,7 +108101,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -107376,15 +108143,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *717 + schema: *732 examples: alternative-response-with-extra-repository-information: value: @@ -107534,9 +108301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 requestBody: required: false content: @@ -107586,9 +108353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *712 - - *354 - - *355 + - *727 + - *356 + - *357 responses: '204': description: Response @@ -107613,7 +108380,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *712 + - *727 - *17 - *19 responses: @@ -107625,7 +108392,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *718 + response-if-child-teams-exist: *733 headers: Link: *70 '404': *6 @@ -107658,7 +108425,7 @@ paths: application/json: schema: oneOf: - - &719 + - &734 title: Private User description: Private User type: object @@ -107861,7 +108628,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - &746 + - &761 title: Public User description: Public User type: object @@ -108173,7 +108940,7 @@ paths: description: Response content: application/json: - schema: *719 + schema: *734 examples: default: value: @@ -108519,7 +109286,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -108527,7 +109294,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -108571,7 +109338,7 @@ paths: type: integer secrets: type: array - items: &720 + items: &735 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -108611,7 +109378,7 @@ paths: - visibility - selected_repositories_url examples: - default: *479 + default: *481 headers: Link: *70 x-github: @@ -108687,7 +109454,7 @@ paths: description: Response content: application/json: - schema: *720 + schema: *735 examples: default: value: @@ -108985,7 +109752,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '304': *37 '500': *55 '401': *25 @@ -109043,7 +109810,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '401': *25 '403': *29 '404': *6 @@ -109100,7 +109867,7 @@ paths: description: Response content: application/json: - schema: &721 + schema: &736 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -109141,7 +109908,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &722 + default: &737 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -109186,9 +109953,9 @@ paths: description: Response content: application/json: - schema: *721 + schema: *736 examples: - default: *722 + default: *737 '404': *6 x-github: githubCloudOnly: false @@ -109225,9 +109992,9 @@ paths: type: integer machines: type: array - items: *723 + items: *738 examples: - default: *724 + default: *739 '304': *37 '500': *55 '401': *25 @@ -109306,13 +110073,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *357 + repository: *359 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *477 - required: *478 + properties: *479 + required: *480 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -110094,7 +110861,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '304': *37 '500': *55 '400': *14 @@ -110134,7 +110901,7 @@ paths: application/json: schema: *262 examples: - default: *476 + default: *478 '500': *55 '401': *25 '403': *29 @@ -110166,7 +110933,7 @@ paths: type: array items: *275 examples: - default: &736 + default: &751 value: - id: 197 name: hello_docker @@ -110267,7 +111034,7 @@ paths: application/json: schema: type: array - items: &725 + items: &740 title: Email description: Email type: object @@ -110332,9 +111099,9 @@ paths: application/json: schema: type: array - items: *725 + items: *740 examples: - default: &738 + default: &753 value: - email: octocat@github.com verified: true @@ -110409,7 +111176,7 @@ paths: application/json: schema: type: array - items: *725 + items: *740 examples: default: value: @@ -110665,7 +111432,7 @@ paths: application/json: schema: type: array - items: &726 + items: &741 title: GPG Key description: A unique encryption key type: object @@ -110796,7 +111563,7 @@ paths: - subkeys - revoked examples: - default: &756 + default: &771 value: - id: 3 name: Octocat's GPG Key @@ -110881,9 +111648,9 @@ paths: description: Response content: application/json: - schema: *726 + schema: *741 examples: - default: &727 + default: &742 value: id: 3 name: Octocat's GPG Key @@ -110940,7 +111707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &728 + - &743 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -110952,9 +111719,9 @@ paths: description: Response content: application/json: - schema: *726 + schema: *741 examples: - default: *727 + default: *742 '404': *6 '304': *37 '403': *29 @@ -110977,7 +111744,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *728 + - *743 responses: '204': description: Response @@ -111294,7 +112061,7 @@ paths: required: true content: application/json: - schema: *553 + schema: *555 examples: default: value: @@ -111444,7 +112211,7 @@ paths: application/json: schema: type: array - items: &729 + items: &744 title: Key description: Key type: object @@ -111545,9 +112312,9 @@ paths: description: Response content: application/json: - schema: *729 + schema: *744 examples: - default: &730 + default: &745 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -111580,15 +112347,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *606 + - *608 responses: '200': description: Response content: application/json: - schema: *729 + schema: *744 examples: - default: *730 + default: *745 '404': *6 '304': *37 '403': *29 @@ -111611,7 +112378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *606 + - *608 responses: '204': description: Response @@ -111644,7 +112411,7 @@ paths: application/json: schema: type: array - items: &731 + items: &746 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -111712,7 +112479,7 @@ paths: - account - plan examples: - default: &732 + default: &747 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -111774,9 +112541,9 @@ paths: application/json: schema: type: array - items: *731 + items: *746 examples: - default: *732 + default: *747 headers: Link: *70 '304': *37 @@ -112019,7 +112786,7 @@ paths: application/json: schema: *266 examples: - default: &733 + default: &748 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -112068,7 +112835,7 @@ paths: application/json: schema: *266 examples: - default: *733 + default: *748 '403': *29 '404': *6 '422': *15 @@ -112793,7 +113560,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *269 - - *734 + - *749 responses: '204': description: Response @@ -112906,7 +113673,7 @@ paths: - docker - nuget - container - - *735 + - *750 - *19 - *17 responses: @@ -112918,8 +113685,8 @@ paths: type: array items: *275 examples: - default: *736 - '400': *737 + default: *751 + '400': *752 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112948,7 +113715,7 @@ paths: application/json: schema: *275 examples: - default: &757 + default: &772 value: id: 40201 name: octo-name @@ -113310,9 +114077,9 @@ paths: application/json: schema: type: array - items: *725 + items: *740 examples: - default: *738 + default: *753 headers: Link: *70 '304': *37 @@ -113425,7 +114192,7 @@ paths: type: array items: *82 examples: - default: &745 + default: &760 summary: Default response value: - id: 1296269 @@ -113729,9 +114496,9 @@ paths: description: Response content: application/json: - schema: *357 + schema: *359 examples: - default: *359 + default: *361 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -113770,9 +114537,9 @@ paths: application/json: schema: type: array - items: *556 + items: *558 examples: - default: *739 + default: *754 headers: Link: *70 '304': *37 @@ -113852,7 +114619,7 @@ paths: application/json: schema: type: array - items: &740 + items: &755 title: Social account description: Social media account type: object @@ -113867,7 +114634,7 @@ paths: - provider - url examples: - default: &741 + default: &756 value: - provider: twitter url: https://twitter.com/github @@ -113929,9 +114696,9 @@ paths: application/json: schema: type: array - items: *740 + items: *755 examples: - default: *741 + default: *756 '422': *15 '304': *37 '404': *6 @@ -114018,7 +114785,7 @@ paths: application/json: schema: type: array - items: &742 + items: &757 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -114038,7 +114805,7 @@ paths: - title - created_at examples: - default: &774 + default: &789 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114102,9 +114869,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *757 examples: - default: &743 + default: &758 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -114134,7 +114901,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &744 + - &759 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -114146,9 +114913,9 @@ paths: description: Response content: application/json: - schema: *742 + schema: *757 examples: - default: *743 + default: *758 '404': *6 '304': *37 '403': *29 @@ -114171,7 +114938,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *744 + - *759 responses: '204': description: Response @@ -114200,7 +114967,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &775 + - &790 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -114225,11 +114992,11 @@ paths: type: array items: *82 examples: - default-response: *745 + default-response: *760 application/vnd.github.v3.star+json: schema: type: array - items: &776 + items: &791 title: Starred Repository description: Starred Repository type: object @@ -114385,8 +115152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response if this repository is starred by you @@ -114414,8 +115181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -114439,8 +115206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *354 - - *355 + - *356 + - *357 responses: '204': description: Response @@ -114512,7 +115279,7 @@ paths: application/json: schema: type: array - items: *350 + items: *352 examples: default: value: @@ -114598,10 +115365,10 @@ paths: application/json: schema: oneOf: - - *719 - - *746 + - *734 + - *761 examples: - default-response: &750 + default-response: &765 summary: Default response value: login: octocat @@ -114636,7 +115403,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &751 + response-with-git-hub-plan-information: &766 summary: Response with GitHub plan information value: login: octocat @@ -114693,7 +115460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &748 + - &763 name: user_id description: The unique identifier of the user. in: path @@ -114759,7 +115526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *747 + - *762 - *17 responses: '200': @@ -114794,7 +115561,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *748 + - *763 - *293 requestBody: required: true @@ -114866,7 +115633,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *749 + schema: *764 examples: table_view: summary: Response for creating a table view @@ -114918,11 +115685,11 @@ paths: application/json: schema: oneOf: - - *719 - - *746 + - *734 + - *761 examples: - default-response: *750 - response-with-git-hub-plan-information: *751 + default-response: *765 + response-with-git-hub-plan-information: *766 '404': *6 x-github: githubCloudOnly: false @@ -114972,8 +115739,8 @@ paths: required: - subject_digests examples: - default: *752 - withPredicateType: *753 + default: *767 + withPredicateType: *768 responses: '200': description: Response @@ -115012,7 +115779,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *754 + default: *769 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -115201,7 +115968,7 @@ paths: initiator: type: string examples: - default: *414 + default: *416 '201': description: Response content: @@ -115482,7 +116249,7 @@ paths: application/json: schema: *204 examples: - default: &755 + default: &770 summary: Example response for a user copilot space value: id: 42 @@ -115583,7 +116350,7 @@ paths: application/json: schema: *204 examples: - default: *755 + default: *770 '403': *29 '404': *6 x-github: @@ -115706,7 +116473,7 @@ paths: application/json: schema: *204 examples: - default: *755 + default: *770 '403': *29 '404': *6 '422': *15 @@ -116474,7 +117241,7 @@ paths: type: array items: *275 examples: - default: *736 + default: *751 '403': *29 '401': *25 x-github: @@ -116858,9 +117625,9 @@ paths: application/json: schema: type: array - items: *726 + items: *741 examples: - default: *756 + default: *771 headers: Link: *70 x-github: @@ -116964,7 +117731,7 @@ paths: application/json: schema: *22 examples: - default: *552 + default: *554 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117088,7 +117855,7 @@ paths: - docker - nuget - container - - *735 + - *750 - *74 - *19 - *17 @@ -117101,10 +117868,10 @@ paths: type: array items: *275 examples: - default: *736 + default: *751 '403': *29 '401': *25 - '400': *737 + '400': *752 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117134,7 +117901,7 @@ paths: application/json: schema: *275 examples: - default: *757 + default: *772 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117483,7 +118250,7 @@ paths: type: array items: *297 examples: - default: *758 + default: *773 headers: Link: *70 '304': *37 @@ -117543,7 +118310,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *759 + items: *774 required: - name - data_type @@ -117559,7 +118326,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *760 + iteration_configuration: *775 required: - name - data_type @@ -117581,8 +118348,8 @@ paths: value: name: Due date data_type: date - single_select_field: *761 - iteration_field: *762 + single_select_field: *776 + iteration_field: *777 responses: '201': description: Response @@ -117590,11 +118357,11 @@ paths: application/json: schema: *297 examples: - text_field: *763 - number_field: *764 - date_field: *765 - single_select_field: *766 - iteration_field: *767 + text_field: *778 + number_field: *779 + date_field: *780 + single_select_field: *781 + iteration_field: *782 '304': *37 '403': *29 '401': *25 @@ -117616,7 +118383,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *293 - - *768 + - *783 - *74 responses: '200': @@ -117625,7 +118392,7 @@ paths: application/json: schema: *297 examples: - default: *769 + default: *784 headers: Link: *70 '304': *37 @@ -117979,7 +118746,7 @@ paths: parameters: - *293 - *74 - - *770 + - *785 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -118518,7 +119285,7 @@ paths: parameters: - *74 - *124 - - *771 + - *786 - *126 responses: '200': @@ -118617,9 +119384,9 @@ paths: - *124 - *125 - *126 - - *772 + - *787 - *129 - - *773 + - *788 responses: '200': description: Response when getting a billing usage summary @@ -118753,9 +119520,9 @@ paths: application/json: schema: type: array - items: *740 + items: *755 examples: - default: *741 + default: *756 headers: Link: *70 x-github: @@ -118785,9 +119552,9 @@ paths: application/json: schema: type: array - items: *742 + items: *757 examples: - default: *774 + default: *789 headers: Link: *70 x-github: @@ -118812,7 +119579,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *775 + - *790 - *62 - *17 - *19 @@ -118824,11 +119591,11 @@ paths: schema: anyOf: - type: array - items: *776 + items: *791 - type: array items: *82 examples: - default-response: *745 + default-response: *760 headers: Link: *70 x-github: @@ -118987,7 +119754,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &777 + enterprise: &792 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -119045,7 +119812,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &778 + installation: &793 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -119064,7 +119831,7 @@ x-webhooks: required: - id - node_id - organization: &779 + organization: &794 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -119124,13 +119891,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &780 + repository: &795 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &812 + properties: &827 id: description: Unique identifier of the repository example: 42 @@ -119814,7 +120581,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &813 + required: &828 - archive_url - assignees_url - blobs_url @@ -119965,10 +120732,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -120044,11 +120811,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: &781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: &796 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -120271,11 +121038,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: *781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: *796 sender: *4 required: - action @@ -120458,11 +121225,11 @@ x-webhooks: - everyone required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - rule: *781 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + rule: *796 sender: *4 required: - action @@ -120546,7 +121313,7 @@ x-webhooks: type: string enum: - completed - check_run: &783 + check_run: &798 title: CheckRun description: A check performed on the code of a given code change type: object @@ -120637,7 +121404,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *782 + deployment: *797 details_url: example: https://example.com type: string @@ -120722,10 +121489,10 @@ x-webhooks: - output - app - pull_requests - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -121116,11 +121883,11 @@ x-webhooks: type: string enum: - created - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -121514,11 +122281,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 requested_action: description: The action requested by the user. type: object @@ -121921,11 +122688,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *783 - installation: *778 - enterprise: *777 - organization: *779 - repository: *780 + check_run: *798 + installation: *793 + enterprise: *792 + organization: *794 + repository: *795 sender: *4 required: - check_run @@ -122895,10 +123662,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -123597,10 +124364,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -124293,10 +125060,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -124462,7 +125229,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -124607,20 +125374,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &784 + commit_oid: &799 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *777 - installation: *778 - organization: *779 - ref: &785 + enterprise: *792 + installation: *793 + organization: *794 + ref: &800 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -124785,7 +125552,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -125015,12 +125782,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -125115,7 +125882,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -125286,12 +126053,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -125457,7 +126224,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -125623,12 +126390,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -125727,7 +126494,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -125902,16 +126669,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *780 + repository: *795 sender: *4 required: - action @@ -126008,7 +126775,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -126148,12 +126915,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *784 - enterprise: *777 - installation: *778 - organization: *779 - ref: *785 - repository: *780 + commit_oid: *799 + enterprise: *792 + installation: *793 + organization: *794 + ref: *800 + repository: *795 sender: *4 required: - action @@ -126319,7 +127086,7 @@ x-webhooks: required: - login - id - dismissed_comment: *448 + dismissed_comment: *450 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126464,10 +127231,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -126722,10 +127489,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -126805,18 +127572,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *779 - pusher_type: &786 + organization: *794 + pusher_type: &801 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &787 + ref: &802 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -126826,7 +127593,7 @@ x-webhooks: enum: - tag - branch - repository: *780 + repository: *795 sender: *4 required: - ref @@ -126909,9 +127676,9 @@ x-webhooks: enum: - created definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -126996,9 +127763,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127076,9 +127843,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127156,9 +127923,9 @@ x-webhooks: enum: - updated definition: *305 - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -127235,10 +128002,10 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - repository: *780 - organization: *779 + enterprise: *792 + installation: *793 + repository: *795 + organization: *794 sender: *4 new_property_values: type: array @@ -127323,18 +128090,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - pusher_type: *786 - ref: *787 + enterprise: *792 + installation: *793 + organization: *794 + pusher_type: *801 + ref: *802 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *780 + repository: *795 sender: *4 required: - ref @@ -127414,11 +128181,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127498,11 +128265,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127583,11 +128350,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127668,11 +128435,11 @@ x-webhooks: type: string enum: - created - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127751,11 +128518,11 @@ x-webhooks: type: string enum: - dismissed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127834,11 +128601,11 @@ x-webhooks: type: string enum: - fixed - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -127918,11 +128685,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128001,11 +128768,11 @@ x-webhooks: type: string enum: - reopened - alert: *512 - installation: *778 - organization: *779 - enterprise: *777 - repository: *780 + alert: *514 + installation: *793 + organization: *794 + enterprise: *792 + repository: *795 sender: *4 required: - action @@ -128082,9 +128849,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - key: &788 + enterprise: *792 + installation: *793 + key: &803 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -128120,8 +128887,8 @@ x-webhooks: - verified - created_at - read_only - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -128198,11 +128965,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - key: *788 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + key: *803 + organization: *794 + repository: *795 sender: *4 required: - action @@ -128758,12 +129525,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: &794 + workflow: &809 title: Workflow type: object nullable: true @@ -129504,15 +130271,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *789 - required: *790 + properties: *804 + required: *805 nullable: true pull_requests: type: array - items: *625 - repository: *780 - organization: *779 - installation: *778 + items: *627 + repository: *795 + organization: *794 + installation: *793 sender: *4 responses: '200': @@ -129583,7 +130350,7 @@ x-webhooks: type: string enum: - approved - approver: &791 + approver: &806 type: object properties: avatar_url: @@ -129626,11 +130393,11 @@ x-webhooks: type: string comment: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - reviewers: &792 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + reviewers: &807 type: array items: type: object @@ -129709,7 +130476,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &793 + workflow_job_run: &808 type: object properties: conclusion: @@ -130440,18 +131207,18 @@ x-webhooks: type: string enum: - rejected - approver: *791 + approver: *806 comment: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - reviewers: *792 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + reviewers: *807 sender: *4 since: type: string - workflow_job_run: *793 + workflow_job_run: *808 workflow_job_runs: type: array items: @@ -131155,13 +131922,13 @@ x-webhooks: type: string enum: - requested - enterprise: *777 + enterprise: *792 environment: type: string - installation: *778 - organization: *779 - repository: *780 - requestor: &799 + installation: *793 + organization: *794 + repository: *795 + requestor: &814 title: User type: object nullable: true @@ -133050,12 +133817,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Deployment Workflow Run type: object @@ -133735,7 +134502,7 @@ x-webhooks: type: string enum: - answered - answer: &797 + answer: &812 type: object properties: author_association: @@ -133892,11 +134659,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134023,11 +134790,11 @@ x-webhooks: - from required: - category - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134110,11 +134877,11 @@ x-webhooks: type: string enum: - closed - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134196,7 +134963,7 @@ x-webhooks: type: string enum: - created - comment: &796 + comment: &811 type: object properties: author_association: @@ -134353,11 +135120,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134440,12 +135207,12 @@ x-webhooks: type: string enum: - deleted - comment: *796 - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + comment: *811 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134540,12 +135307,12 @@ x-webhooks: - from required: - body - comment: *796 - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + comment: *811 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134629,11 +135396,11 @@ x-webhooks: type: string enum: - created - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134715,11 +135482,11 @@ x-webhooks: type: string enum: - deleted - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134819,11 +135586,11 @@ x-webhooks: type: string required: - from - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -134905,10 +135672,10 @@ x-webhooks: type: string enum: - labeled - discussion: *795 - enterprise: *777 - installation: *778 - label: &798 + discussion: *810 + enterprise: *792 + installation: *793 + label: &813 title: Label type: object properties: @@ -134940,8 +135707,8 @@ x-webhooks: - color - default - description - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135024,11 +135791,11 @@ x-webhooks: type: string enum: - locked - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135110,11 +135877,11 @@ x-webhooks: type: string enum: - pinned - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135196,11 +135963,11 @@ x-webhooks: type: string enum: - reopened - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135285,16 +136052,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *795 - new_repository: *780 + new_discussion: *810 + new_repository: *795 required: - new_discussion - new_repository - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135377,10 +136144,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *795 - old_answer: *797 - organization: *779 - repository: *780 + discussion: *810 + old_answer: *812 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135462,12 +136229,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *795 - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135550,11 +136317,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135636,11 +136403,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *795 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + discussion: *810 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -135713,7 +136480,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *777 + enterprise: *792 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -136373,9 +137140,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - forkee @@ -136521,9 +137288,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pages: description: The pages that were updated. type: array @@ -136560,7 +137327,7 @@ x-webhooks: - action - sha - html_url - repository: *780 + repository: *795 sender: *4 required: - pages @@ -136636,10 +137403,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: &800 + organization: *794 + repositories: &815 description: An array of repository objects that the installation can access. type: array @@ -136665,8 +137432,8 @@ x-webhooks: - name - full_name - private - repository: *780 - requester: *799 + repository: *795 + requester: *814 sender: *4 required: - action @@ -136741,11 +137508,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -136821,11 +137588,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -136901,10 +137668,10 @@ x-webhooks: type: string enum: - added - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories_added: &801 + organization: *794 + repositories_added: &816 description: An array of repository objects, which were added to the installation. type: array @@ -136950,15 +137717,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *780 - repository_selection: &802 + repository: *795 + repository_selection: &817 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *799 + requester: *814 sender: *4 required: - action @@ -137037,10 +137804,10 @@ x-webhooks: type: string enum: - removed - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories_added: *801 + organization: *794 + repositories_added: *816 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -137067,9 +137834,9 @@ x-webhooks: - name - full_name - private - repository: *780 - repository_selection: *802 - requester: *799 + repository: *795 + repository_selection: *817 + requester: *814 sender: *4 required: - action @@ -137148,11 +137915,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -137330,10 +138097,10 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 target_type: type: string @@ -137412,11 +138179,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *777 + enterprise: *792 installation: *22 - organization: *779 - repositories: *800 - repository: *780 + organization: *794 + repositories: *815 + repository: *795 requester: nullable: true sender: *4 @@ -137590,15 +138357,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true user: title: User @@ -137683,8 +138450,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -138473,8 +139240,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138823,8 +139590,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -138904,7 +139671,7 @@ x-webhooks: type: string enum: - deleted - comment: &803 + comment: &818 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -139061,15 +139828,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *589 - required: *590 + properties: *591 + required: *592 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *591 - required: *592 + properties: *593 + required: *594 nullable: true required: - url @@ -139084,8 +139851,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139870,8 +140637,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140222,8 +140989,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -140303,7 +141070,7 @@ x-webhooks: type: string enum: - edited - changes: &832 + changes: &847 description: The changes to the comment. type: object properties: @@ -140315,9 +141082,9 @@ x-webhooks: type: string required: - from - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141105,8 +141872,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141455,8 +142222,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -141537,9 +142304,9 @@ x-webhooks: type: string enum: - pinned - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142329,8 +143096,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142681,8 +143448,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -142762,9 +143529,9 @@ x-webhooks: type: string enum: - unpinned - comment: *803 - enterprise: *777 - installation: *778 + comment: *818 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143554,8 +144321,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143906,8 +144673,8 @@ x-webhooks: - state - locked - assignee - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -143996,9 +144763,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144087,9 +144854,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144177,9 +144944,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144268,9 +145035,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -144350,10 +145117,10 @@ x-webhooks: type: string enum: - assigned - assignee: *799 - enterprise: *777 - installation: *778 - issue: &804 + assignee: *814 + enterprise: *792 + installation: *793 + issue: &819 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -145145,11 +145912,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145266,8 +146033,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -145347,8 +146114,8 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146145,11 +146912,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146401,8 +147168,8 @@ x-webhooks: required: - state - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -146481,8 +147248,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147270,11 +148037,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147390,8 +148157,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -147470,8 +148237,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148281,11 +149048,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148380,7 +149147,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &805 + milestone: &820 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148518,8 +149285,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -148618,8 +149385,8 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149411,11 +150178,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149532,9 +150299,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *798 - organization: *779 - repository: *780 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -149614,9 +150381,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 issue_field: type: object description: The issue field whose value was set or updated on the @@ -149770,8 +150537,8 @@ x-webhooks: - id required: - from - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -149851,9 +150618,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -149934,8 +150701,8 @@ x-webhooks: nullable: true required: - id - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -150015,8 +150782,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150807,11 +151574,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150928,9 +151695,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *798 - organization: *779 - repository: *780 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -151010,8 +151777,8 @@ x-webhooks: type: string enum: - locked - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151826,11 +152593,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151924,8 +152691,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -152004,8 +152771,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152814,11 +153581,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152912,9 +153679,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *805 - organization: *779 - repository: *780 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -153777,11 +154544,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154362,8 +155129,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155147,11 +155914,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155275,8 +156042,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -155356,9 +156123,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *777 - installation: *778 - issue: &806 + enterprise: *792 + installation: *793 + issue: &821 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -156144,11 +156911,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156264,8 +157031,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -156344,8 +157111,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -157158,11 +157925,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157257,8 +158024,8 @@ x-webhooks: user_view_type: type: string type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -158127,11 +158894,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158726,11 +159493,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *777 - installation: *778 - issue: *806 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *821 + organization: *794 + repository: *795 sender: *4 required: - action @@ -158810,12 +159577,12 @@ x-webhooks: type: string enum: - typed - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -158896,7 +159663,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &835 + assignee: &850 title: User type: object nullable: true @@ -158966,11 +159733,11 @@ x-webhooks: required: - login - id - enterprise: *777 - installation: *778 - issue: *804 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *819 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159049,12 +159816,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *777 - installation: *778 - issue: *804 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *819 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -159134,8 +159901,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -159948,11 +160715,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *710 - issue_dependencies_summary: *711 + sub_issues_summary: *725 + issue_dependencies_summary: *726 issue_field_values: type: array - items: *573 + items: *575 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160046,8 +160813,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160127,11 +160894,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *777 - installation: *778 - issue: *806 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + issue: *821 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160210,12 +160977,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *777 - installation: *778 - issue: *804 + enterprise: *792 + installation: *793 + issue: *819 type: *257 - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160295,11 +161062,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160377,11 +161144,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160491,11 +161258,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - label: *798 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + label: *813 + organization: *794 + repository: *795 sender: *4 required: - action @@ -160577,9 +161344,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: &807 + enterprise: *792 + installation: *793 + marketplace_purchase: &822 title: Marketplace Purchase type: object required: @@ -160662,8 +161429,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *779 - previous_marketplace_purchase: &808 + organization: *794 + previous_marketplace_purchase: &823 title: Marketplace Purchase type: object properties: @@ -160743,7 +161510,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -160823,10 +161590,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -160909,7 +161676,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -160991,10 +161758,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161076,7 +161843,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *780 + repository: *795 sender: *4 required: - action @@ -161157,8 +161924,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 marketplace_purchase: title: Marketplace Purchase type: object @@ -161240,9 +162007,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *779 - previous_marketplace_purchase: *808 - repository: *780 + organization: *794 + previous_marketplace_purchase: *823 + repository: *795 sender: *4 required: - action @@ -161322,12 +162089,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *777 - installation: *778 - marketplace_purchase: *807 - organization: *779 - previous_marketplace_purchase: *808 - repository: *780 + enterprise: *792 + installation: *793 + marketplace_purchase: *822 + organization: *794 + previous_marketplace_purchase: *823 + repository: *795 sender: *4 required: - action @@ -161429,11 +162196,11 @@ x-webhooks: type: string required: - to - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -161533,11 +162300,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -161616,11 +162383,11 @@ x-webhooks: type: string enum: - removed - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 sender: *4 required: - action @@ -161698,11 +162465,11 @@ x-webhooks: type: string enum: - added - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 scope: description: The scope of the membership. Currently, can only be `team`. @@ -161778,7 +162545,7 @@ x-webhooks: required: - login - id - team: &809 + team: &824 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162001,11 +162768,11 @@ x-webhooks: type: string enum: - removed - enterprise: *777 - installation: *778 - member: *799 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + member: *814 + organization: *794 + repository: *795 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162082,7 +162849,7 @@ x-webhooks: required: - login - id - team: *809 + team: *824 required: - action - scope @@ -162164,8 +162931,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *778 - merge_group: &811 + installation: *793 + merge_group: &826 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162184,15 +162951,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *810 + head_commit: *825 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162278,10 +163045,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *778 - merge_group: *811 - organization: *779 - repository: *780 + installation: *793 + merge_group: *826 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162354,7 +163121,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 + enterprise: *792 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -162463,16 +163230,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *778 - organization: *779 + installation: *793 + organization: *794 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -162553,11 +163320,11 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162636,9 +163403,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - milestone: &814 + enterprise: *792 + installation: *793 + milestone: &829 title: Milestone description: A collection of related issues and pull requests. type: object @@ -162775,8 +163542,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162855,11 +163622,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -162969,11 +163736,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - milestone: *805 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *820 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163053,11 +163820,11 @@ x-webhooks: type: string enum: - opened - enterprise: *777 - installation: *778 - milestone: *814 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + milestone: *829 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163136,11 +163903,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *799 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + blocked_user: *814 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163219,11 +163986,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *799 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + blocked_user: *814 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163302,9 +164069,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - membership: &815 + enterprise: *792 + installation: *793 + membership: &830 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -163411,8 +164178,8 @@ x-webhooks: - role - organization_url - user - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163490,11 +164257,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163573,8 +164340,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -163690,10 +164457,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 - user: *799 + user: *814 required: - action - invitation @@ -163771,11 +164538,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163862,11 +164629,11 @@ x-webhooks: properties: from: type: string - enterprise: *777 - installation: *778 - membership: *815 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + membership: *830 + organization: *794 + repository: *795 sender: *4 required: - action @@ -163943,9 +164710,9 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 package: description: Information about the package. type: object @@ -164444,7 +165211,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &816 + items: &831 title: Ruby Gems metadata type: object properties: @@ -164539,7 +165306,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -164615,9 +165382,9 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 package: description: Information about the package. type: object @@ -164970,7 +165737,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *816 + items: *831 source_url: type: string format: uri @@ -165040,7 +165807,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -165216,12 +165983,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *777 + enterprise: *792 id: type: integer - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - id @@ -165298,7 +166065,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &817 + personal_access_token_request: &832 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -165444,10 +166211,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *777 - organization: *779 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -165524,11 +166291,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *817 - enterprise: *777 - organization: *779 + personal_access_token_request: *832 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -165604,11 +166371,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *817 - enterprise: *777 - organization: *779 + personal_access_token_request: *832 + enterprise: *792 + organization: *794 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -165683,11 +166450,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *817 - organization: *779 - enterprise: *777 + personal_access_token_request: *832 + organization: *794 + enterprise: *792 sender: *4 - installation: *778 + installation: *793 required: - action - personal_access_token_request @@ -165792,7 +166559,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *818 + last_response: *833 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -165824,8 +166591,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 zen: description: Random string of GitHub zen. @@ -166070,10 +166837,10 @@ x-webhooks: - from required: - note - enterprise: *777 - installation: *778 - organization: *779 - project_card: &819 + enterprise: *792 + installation: *793 + organization: *794 + project_card: &834 title: Project Card type: object properties: @@ -166192,7 +166959,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -166273,11 +167040,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project_card: *819 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_card: *834 + repository: *795 sender: *4 required: - action @@ -166357,9 +167124,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 project_card: title: Project Card type: object @@ -166487,8 +167254,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -166582,11 +167349,11 @@ x-webhooks: - from required: - note - enterprise: *777 - installation: *778 - organization: *779 - project_card: *819 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_card: *834 + repository: *795 sender: *4 required: - action @@ -166680,9 +167447,9 @@ x-webhooks: - from required: - column_id - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 project_card: allOf: - title: Project Card @@ -166872,7 +167639,7 @@ x-webhooks: type: string required: - after_id - repository: *780 + repository: *795 sender: *4 required: - action @@ -166952,10 +167719,10 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - organization: *779 - project: &821 + enterprise: *792 + installation: *793 + organization: *794 + project: &836 title: Project type: object properties: @@ -167079,7 +167846,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -167159,10 +167926,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project_column: &820 + enterprise: *792 + installation: *793 + organization: *794 + project_column: &835 title: Project Column type: object properties: @@ -167201,7 +167968,7 @@ x-webhooks: - name - created_at - updated_at - repository: *780 + repository: *795 sender: *4 required: - action @@ -167280,18 +168047,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -167381,11 +168148,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 + repository: *795 sender: *4 required: - action @@ -167465,11 +168232,11 @@ x-webhooks: type: string enum: - moved - enterprise: *777 - installation: *778 - organization: *779 - project_column: *820 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project_column: *835 + repository: *795 sender: *4 required: - action @@ -167549,11 +168316,11 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -167633,18 +168400,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - project: *821 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *812 - required: *813 + properties: *827 + required: *828 nullable: true sender: *4 required: @@ -167746,11 +168513,11 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -167829,11 +168596,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 - organization: *779 - project: *821 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + project: *836 + repository: *795 sender: *4 required: - action @@ -167914,8 +168681,8 @@ x-webhooks: type: string enum: - closed - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -167997,8 +168764,8 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168080,8 +168847,8 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168199,8 +168966,8 @@ x-webhooks: type: string to: type: string - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -168284,7 +169051,7 @@ x-webhooks: type: string enum: - archived - changes: &825 + changes: &840 type: object properties: archived_at: @@ -168298,9 +169065,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *778 - organization: *779 - projects_v2_item: &822 + installation: *793 + organization: *794 + projects_v2_item: &837 title: Projects v2 Item description: An item belonging to a project type: object @@ -168435,9 +169202,9 @@ x-webhooks: nullable: true to: type: string - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168519,9 +169286,9 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168602,9 +169369,9 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168710,7 +169477,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &823 + - &838 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -168732,7 +169499,7 @@ x-webhooks: required: - id - name - - &824 + - &839 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -168766,8 +169533,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *823 - - *824 + - *838 + - *839 required: - field_value - type: object @@ -168783,9 +169550,9 @@ x-webhooks: nullable: true required: - body - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168880,9 +169647,9 @@ x-webhooks: to: type: string nullable: true - installation: *778 - organization: *779 - projects_v2_item: *822 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -168965,10 +169732,10 @@ x-webhooks: type: string enum: - restored - changes: *825 - installation: *778 - organization: *779 - projects_v2_item: *822 + changes: *840 + installation: *793 + organization: *794 + projects_v2_item: *837 sender: *4 required: - action @@ -169050,8 +169817,8 @@ x-webhooks: type: string enum: - reopened - installation: *778 - organization: *779 + installation: *793 + organization: *794 projects_v2: *291 sender: *4 required: @@ -169133,14 +169900,14 @@ x-webhooks: type: string enum: - created - installation: *778 - organization: *779 - projects_v2_status_update: &828 + installation: *793 + organization: *794 + projects_v2_status_update: &843 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *826 - required: *827 + properties: *841 + required: *842 sender: *4 required: - action @@ -169221,9 +169988,9 @@ x-webhooks: type: string enum: - deleted - installation: *778 - organization: *779 - projects_v2_status_update: *828 + installation: *793 + organization: *794 + projects_v2_status_update: *843 sender: *4 required: - action @@ -169359,9 +170126,9 @@ x-webhooks: type: string format: date nullable: true - installation: *778 - organization: *779 - projects_v2_status_update: *828 + installation: *793 + organization: *794 + projects_v2_status_update: *843 sender: *4 required: - action @@ -169432,10 +170199,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - repository @@ -169512,13 +170279,13 @@ x-webhooks: type: string enum: - assigned - assignee: *799 - enterprise: *777 - installation: *778 - number: &829 + assignee: *814 + enterprise: *792 + installation: *793 + number: &844 description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -171805,7 +172572,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -171887,11 +172654,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -174173,7 +174940,7 @@ x-webhooks: - draft reason: type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -174255,11 +175022,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -176541,7 +177308,7 @@ x-webhooks: - draft reason: type: string - repository: *780 + repository: *795 sender: *4 required: - action @@ -176623,13 +177390,13 @@ x-webhooks: type: string enum: - closed - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: &830 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: &845 allOf: - - *625 + - *627 - type: object properties: allow_auto_merge: @@ -176691,7 +177458,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *780 + repository: *795 sender: *4 required: - action @@ -176772,12 +177539,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -176857,11 +177624,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *777 - milestone: *609 - number: *829 - organization: *779 - pull_request: &831 + enterprise: *792 + milestone: *611 + number: *844 + organization: *794 + pull_request: &846 title: Pull Request type: object properties: @@ -179142,7 +179909,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -179221,11 +179988,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -181525,7 +182292,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *780 + repository: *795 sender: *4 required: - action @@ -181649,12 +182416,12 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -181734,11 +182501,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -184023,7 +184790,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -184103,11 +184870,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *777 - installation: *778 - label: *798 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + label: *813 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -186393,7 +187160,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -186474,10 +187241,10 @@ x-webhooks: type: string enum: - locked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -188761,7 +189528,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -188841,12 +189608,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *777 - milestone: *609 - number: *829 - organization: *779 - pull_request: *831 - repository: *780 + enterprise: *792 + milestone: *611 + number: *844 + organization: *794 + pull_request: *846 + repository: *795 sender: *4 required: - action @@ -188925,12 +189692,12 @@ x-webhooks: type: string enum: - opened - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -189011,12 +189778,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -189096,12 +189863,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *777 - installation: *778 - number: *829 - organization: *779 - pull_request: *830 - repository: *780 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 + pull_request: *845 + repository: *795 sender: *4 required: - action @@ -189467,9 +190234,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -191643,7 +192410,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -191723,7 +192490,7 @@ x-webhooks: type: string enum: - deleted - comment: &833 + comment: &848 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192008,9 +192775,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -194172,7 +194939,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -194252,11 +195019,11 @@ x-webhooks: type: string enum: - edited - changes: *832 - comment: *833 - enterprise: *777 - installation: *778 - organization: *779 + changes: *847 + comment: *848 + enterprise: *792 + installation: *793 + organization: *794 pull_request: type: object properties: @@ -196421,7 +197188,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *780 + repository: *795 sender: *4 required: - action @@ -196502,9 +197269,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -198681,7 +199448,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 review: description: The review that was affected. type: object @@ -198928,9 +199695,9 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -200980,8 +201747,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 - review: &834 + repository: *795 + review: &849 description: The review that was affected. type: object properties: @@ -201214,12 +201981,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -203506,7 +204273,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_reviewer: title: User type: object @@ -203590,12 +204357,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -205889,7 +206656,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_team: title: Team description: Groups of organization members that gives permissions @@ -206081,12 +206848,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -208375,7 +209142,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_reviewer: title: User type: object @@ -208460,12 +209227,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *777 - installation: *778 + enterprise: *792 + installation: *793 number: description: The pull request number. type: integer - organization: *779 + organization: *794 pull_request: title: Pull Request type: object @@ -210745,7 +211512,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 requested_team: title: Team description: Groups of organization members that gives permissions @@ -210926,9 +211693,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -213107,8 +213874,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 - review: *834 + repository: *795 + review: *849 sender: *4 required: - action @@ -213188,9 +213955,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -215278,7 +216045,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 sender: *4 thread: type: object @@ -215665,9 +216432,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 pull_request: title: Simple Pull Request type: object @@ -217741,7 +218508,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *780 + repository: *795 sender: *4 thread: type: object @@ -218125,10 +218892,10 @@ x-webhooks: type: string enum: - stacked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -220414,7 +221181,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -220500,10 +221267,10 @@ x-webhooks: type: string before: type: string - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -222778,7 +223545,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -222860,11 +223627,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *835 - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + assignee: *850 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -225151,7 +225918,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -225230,11 +225997,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *777 - installation: *778 - label: *798 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + label: *813 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -227511,7 +228278,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -227592,10 +228359,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *777 - installation: *778 - number: *829 - organization: *779 + enterprise: *792 + installation: *793 + number: *844 + organization: *794 pull_request: title: Pull Request type: object @@ -229864,7 +230631,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *780 + repository: *795 sender: *4 required: - action @@ -230064,7 +230831,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *777 + enterprise: *792 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -230156,8 +230923,8 @@ x-webhooks: - url - author - committer - installation: *778 - organization: *779 + installation: *793 + organization: *794 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -230743,9 +231510,9 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 registry_package: type: object properties: @@ -231191,7 +231958,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *816 + items: *831 summary: type: string tag_name: @@ -231245,7 +232012,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -231323,9 +232090,9 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 registry_package: type: object properties: @@ -231633,7 +232400,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *816 + items: *831 summary: type: string tag_name: @@ -231682,7 +232449,7 @@ x-webhooks: - owner - package_version - registry - repository: *780 + repository: *795 sender: *4 required: - action @@ -231759,10 +232526,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - release: &836 + enterprise: *792 + installation: *793 + organization: *794 + release: &851 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -232080,7 +232847,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *780 + repository: *795 sender: *4 required: - action @@ -232157,11 +232924,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -232278,11 +233045,11 @@ x-webhooks: type: boolean required: - to - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -232360,9 +233127,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -232684,7 +233451,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *780 + repository: *795 sender: *4 required: - action @@ -232760,10 +233527,10 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - release: &837 + enterprise: *792 + installation: *793 + organization: *794 + release: &852 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -233082,7 +233849,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *780 + repository: *795 sender: *4 required: - action @@ -233158,11 +233925,11 @@ x-webhooks: type: string enum: - released - enterprise: *777 - installation: *778 - organization: *779 - release: *836 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *851 + repository: *795 sender: *4 required: - action @@ -233238,11 +234005,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *777 - installation: *778 - organization: *779 - release: *837 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + release: *852 + repository: *795 sender: *4 required: - action @@ -233318,11 +234085,11 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - repository_advisory: *697 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + repository_advisory: *712 sender: *4 required: - action @@ -233398,11 +234165,11 @@ x-webhooks: type: string enum: - reported - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - repository_advisory: *697 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + repository_advisory: *712 sender: *4 required: - action @@ -233478,10 +234245,10 @@ x-webhooks: type: string enum: - archived - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -233558,10 +234325,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -233639,10 +234406,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -233726,10 +234493,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -233841,10 +234608,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -233916,10 +234683,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 status: type: string @@ -234000,10 +234767,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234080,10 +234847,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234177,10 +234944,10 @@ x-webhooks: - name required: - repository - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234260,10 +235027,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 sender: *4 required: @@ -234342,10 +235109,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 sender: *4 required: @@ -234424,10 +235191,10 @@ x-webhooks: type: string enum: - edited - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 repository_ruleset: *339 changes: type: object @@ -234489,16 +235256,16 @@ x-webhooks: properties: added: type: array - items: *646 + items: *648 deleted: type: array - items: *646 + items: *648 updated: type: array items: type: object properties: - rule: *646 + rule: *648 changes: type: object properties: @@ -234732,10 +235499,10 @@ x-webhooks: - from required: - owner - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234813,10 +235580,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -234894,7 +235661,7 @@ x-webhooks: type: string enum: - create - alert: &838 + alert: &853 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -235016,10 +235783,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235225,10 +235992,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235306,11 +236073,11 @@ x-webhooks: type: string enum: - reopen - alert: *838 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *853 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235509,10 +236276,10 @@ x-webhooks: enum: - fixed - open - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235590,7 +236357,7 @@ x-webhooks: type: string enum: - assigned - alert: &840 + alert: &855 type: object properties: number: *188 @@ -235732,12 +236499,12 @@ x-webhooks: properties: *20 required: *21 nullable: true - metadata: *839 + metadata: *854 assignee: *4 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235815,11 +236582,11 @@ x-webhooks: type: string enum: - created - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -235900,11 +236667,11 @@ x-webhooks: type: string enum: - created - alert: *840 - installation: *778 - location: *841 - organization: *779 - repository: *780 + alert: *855 + installation: *793 + location: *856 + organization: *794 + repository: *795 sender: *4 required: - location @@ -236142,11 +236909,11 @@ x-webhooks: type: string enum: - metadata_created - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236223,11 +236990,11 @@ x-webhooks: type: string enum: - metadata_removed - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236304,11 +237071,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236386,11 +237153,11 @@ x-webhooks: type: string enum: - reopened - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236468,11 +237235,11 @@ x-webhooks: type: string enum: - resolved - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236550,12 +237317,12 @@ x-webhooks: type: string enum: - unassigned - alert: *840 + alert: *855 assignee: *4 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236633,11 +237400,11 @@ x-webhooks: type: string enum: - validated - alert: *840 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + alert: *855 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -236763,10 +237530,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *780 - enterprise: *777 - installation: *778 - organization: *779 + repository: *795 + enterprise: *792 + installation: *793 + organization: *794 sender: *4 required: - action @@ -236844,11 +237611,11 @@ x-webhooks: type: string enum: - published - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - security_advisory: &842 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + security_advisory: &857 description: The details of the security advisory, including summary, description, and severity. type: object @@ -237019,11 +237786,11 @@ x-webhooks: type: string enum: - updated - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 - security_advisory: *842 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 + security_advisory: *857 sender: *4 required: - action @@ -237096,10 +237863,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -237272,10 +238039,10 @@ x-webhooks: type: object properties: security_and_analysis: *312 - enterprise: *777 - installation: *778 - organization: *779 - repository: *357 + enterprise: *792 + installation: *793 + organization: *794 + repository: *359 sender: *4 required: - changes @@ -237353,12 +238120,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: &843 + sponsorship: &858 type: object properties: created_at: @@ -237659,12 +238426,12 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - sponsorship @@ -237752,12 +238519,12 @@ x-webhooks: type: string required: - from - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -237834,17 +238601,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &844 + effective_date: &859 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - sponsorship @@ -237918,7 +238685,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &845 + changes: &860 type: object properties: tier: @@ -237962,13 +238729,13 @@ x-webhooks: - from required: - tier - effective_date: *844 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + effective_date: *859 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -238045,13 +238812,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *845 - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + changes: *860 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - sponsorship: *843 + sponsorship: *858 required: - action - changes @@ -238125,10 +238892,10 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -238211,10 +238978,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -238634,15 +239401,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *777 + enterprise: *792 id: description: The unique identifier of the status. type: integer - installation: *778 + installation: *793 name: type: string - organization: *779 - repository: *780 + organization: *794 + repository: *795 sender: *4 sha: description: The Commit SHA. @@ -238757,9 +239524,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -238848,9 +239615,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -238939,9 +239706,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239030,9 +239797,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *778 - organization: *779 - repository: *780 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -239108,12 +239875,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - team: &846 + team: &861 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -239336,9 +240103,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -239796,7 +240563,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -239872,9 +240639,9 @@ x-webhooks: type: string enum: - created - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -240332,7 +241099,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -240409,9 +241176,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -240869,7 +241636,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -241013,9 +241780,9 @@ x-webhooks: - from required: - permissions - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -241473,7 +242240,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - changes @@ -241551,9 +242318,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *777 - installation: *778 - organization: *779 + enterprise: *792 + installation: *793 + organization: *794 repository: title: Repository description: A git repository @@ -242011,7 +242778,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *846 + team: *861 required: - action - team @@ -242087,10 +242854,10 @@ x-webhooks: type: string enum: - started - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 required: - action @@ -242163,16 +242930,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *777 + enterprise: *792 inputs: type: object nullable: true additionalProperties: true - installation: *778 - organization: *779 + installation: *793 + organization: *794 ref: type: string - repository: *780 + repository: *795 sender: *4 workflow: type: string @@ -242254,10 +243021,10 @@ x-webhooks: type: string enum: - completed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: allOf: @@ -242494,7 +243261,7 @@ x-webhooks: type: string required: - conclusion - deployment: *519 + deployment: *521 required: - action - repository @@ -242573,10 +243340,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: allOf: @@ -242836,7 +243603,7 @@ x-webhooks: required: - status - steps - deployment: *519 + deployment: *521 required: - action - repository @@ -242915,10 +243682,10 @@ x-webhooks: type: string enum: - queued - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: type: object @@ -243053,7 +243820,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *519 + deployment: *521 required: - action - repository @@ -243132,10 +243899,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 workflow_job: type: object @@ -243271,7 +244038,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *519 + deployment: *521 required: - action - repository @@ -243351,12 +244118,12 @@ x-webhooks: type: string enum: - completed - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object @@ -244355,12 +245122,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object @@ -245344,12 +246111,12 @@ x-webhooks: type: string enum: - requested - enterprise: *777 - installation: *778 - organization: *779 - repository: *780 + enterprise: *792 + installation: *793 + organization: *794 + repository: *795 sender: *4 - workflow: *794 + workflow: *809 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 979d5f4958..4917aaf29c 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -8012,7 +8012,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9014,7 +9014,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -9884,7 +9884,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -10371,7 +10371,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -12531,7 +12531,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -13584,7 +13584,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -14554,7 +14554,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -15235,7 +15235,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -16555,15 +16555,15 @@ }, "/assignments/{assignment_id}": { "get": { - "summary": "Get an assignment", - "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment" }, "parameters": [ { @@ -16892,21 +16892,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { - "summary": "List accepted assignments for an assignment", - "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - List accepted assignments for an assignment", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment" }, "parameters": [ { @@ -17275,21 +17278,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/assignments/{assignment_id}/grades": { "get": { - "summary": "Get assignment grades", - "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "summary": "Closing down - Get assignment grades", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades" }, "parameters": [ { @@ -17438,21 +17444,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms": { "get": { - "summary": "List classrooms", - "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "summary": "Closing down - List classrooms", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms" }, "parameters": [ { @@ -17532,21 +17541,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}": { "get": { - "summary": "Get a classroom", - "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - Get a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom" }, "parameters": [ { @@ -17690,21 +17702,24 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/classrooms/{classroom_id}/assignments": { "get": { - "summary": "List assignments for a classroom", - "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "summary": "Closing down - List assignments for a classroom", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed on August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).\n\nLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + "url": "https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom" }, "parameters": [ { @@ -17930,8 +17945,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -150756,7 +150774,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -151773,7 +151791,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -229861,23 +229879,23 @@ } } }, - "/orgs/{org}/secret-scanning/pattern-configurations": { + "/orgs/{org}/secret-scanning/custom-patterns": { "get": { - "summary": "List organization pattern configurations", - "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List organization custom patterns", + "description": "Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "secret-scanning" ], - "operationId": "secret-scanning/list-org-pattern-configs", + "operationId": "secret-scanning/list-org-custom-patterns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "secret-scanning", - "subcategory": "push-protection" + "subcategory": "custom-patterns" }, "parameters": [ { @@ -229888,6 +229906,79 @@ "schema": { "type": "string" } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -229896,198 +229987,1534 @@ "content": { "application/json": { "schema": { - "title": "Secret scanning pattern configuration", - "description": "A collection of secret scanning patterns and their settings related to push protection.", - "type": "object", - "properties": { - "pattern_config_version": { - "type": "string", - "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", - "nullable": true - }, - "provider_pattern_overrides": { - "type": "array", - "description": "Overrides for partner patterns.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" } - } - }, - "custom_pattern_overrides": { - "type": "array", - "description": "Overrides for custom patterns defined by the organization.", - "items": { - "type": "object", - "properties": { - "token_type": { - "type": "string", - "description": "The ID of the pattern." - }, - "custom_pattern_version": { - "type": "string", - "description": "The version of this pattern if it's a custom pattern.", - "nullable": true - }, - "slug": { - "type": "string", - "description": "The slug of the pattern." - }, - "display_name": { - "type": "string", - "description": "The user-friendly name for the pattern." - }, - "alert_total": { - "type": "integer", - "description": "The total number of alerts generated by this pattern." - }, - "alert_total_percentage": { - "type": "integer", - "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." - }, - "false_positives": { - "type": "integer", - "description": "The number of false positive alerts generated by this pattern." - }, - "false_positive_rate": { - "type": "integer", - "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." - }, - "bypass_rate": { - "type": "integer", - "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." - }, - "default_setting": { - "type": "string", - "description": "The default push protection setting for this pattern.", - "enum": [ - "disabled", - "enabled" - ] - }, - "enterprise_setting": { - "type": "string", - "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", - "enum": [ - "not-set", - "disabled", - "enabled" - ], - "nullable": true - }, - "setting": { - "type": "string", - "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", - "enum": [ - "not-set", - "disabled", - "enabled" - ] - } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." } - } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] } }, "examples": { "default": { - "value": { - "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "provider_pattern_overrides": [ - { - "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", - "slug": "github_personal_access_token_legacy_v2", - "display_name": "GitHub Personal Access Token (Legacy v2)", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 2, - "false_positive_rate": 13, - "bypass_rate": 13, - "default_setting": "enabled", - "setting": "enabled", - "enterprise_setting": "enabled" - } - ], - "custom_pattern_overrides": [ - { - "token_type": "cp_2", - "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", - "slug": "custom-api-key", - "display_name": "Custom API Key", - "alert_total": 15, - "alert_total_percentage": 36, - "false_positives": 3, - "false_positive_rate": 20, - "bypass_rate": 20, - "default_setting": "disabled", - "setting": "enabled" - } - ] - } + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create organization custom patterns", + "description": "Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete organization custom patterns", + "description": "Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-org-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update an organization custom pattern", + "description": "Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } } } } @@ -393588,7 +395015,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -590468,6 +591895,1451 @@ } } }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": { + "get": { + "summary": "List repository custom patterns", + "description": "Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Filter custom patterns by state. When absent, returns patterns in all states.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "published", + "unpublished" + ] + } + }, + { + "name": "push_protection", + "description": "Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "published", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-16T14:20:00Z", + "updated_at": "2024-01-17T09:15:00Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Bulk create repository custom patterns", + "description": "Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-create-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to create.", + "items": { + "title": "Secret Scanning Custom Pattern To Create", + "description": "A custom pattern to create in a bulk operation.", + "type": "object", + "required": [ + "name", + "pattern" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified.", + "default": "\\A|[^0-9A-Za-z]" + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified.", + "default": "\\z|[^0-9A-Za-z]" + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+" + }, + { + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "All patterns created successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created_patterns": { + "type": "array", + "description": "The list of successfully created custom patterns.", + "items": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "created_patterns": [ + { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "[a-z]+_token_[0-9]+", + "slug": "example-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": null, + "end_delimiter": null, + "must_match": null, + "must_not_match": null, + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + }, + { + "id": 2, + "name": "Another Custom Pattern", + "pattern": "prefix_[a-zA-Z0-9]{32}", + "slug": "another-custom-pattern", + "state": "unpublished", + "push_protection_enabled": false, + "start_delimiter": "\\b", + "end_delimiter": "\\b", + "must_match": [ + "^prefix_prod" + ], + "must_not_match": [ + "test" + ], + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-01-15T10:30:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed for one or more patterns.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A summary message describing the error." + }, + "validation_errors": { + "type": "object", + "description": "A map of validation errors keyed by the zero-based index of the pattern that failed.", + "additionalProperties": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "List of validation errors for this pattern.", + "items": { + "title": "Secret Scanning Custom Pattern Validation Error", + "description": "A validation error for a custom pattern in a batch operation.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "A machine-readable code describing the error.", + "enum": [ + "none", + "config_load", + "compile_db", + "start_delimiter", + "end_delimiter", + "display_name", + "must_match", + "must_not_match", + "custom_pattern_version_mismatch", + "db_size", + "db_size_calculation" + ] + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Bulk delete repository custom patterns", + "description": "Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/bulk-delete-repo-custom-patterns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "patterns" + ], + "properties": { + "patterns": { + "type": "array", + "description": "The list of custom patterns to delete.", + "maxItems": 500, + "items": { + "title": "Secret Scanning Custom Pattern To Delete", + "description": "A custom pattern to delete in a bulk operation.", + "type": "object", + "required": [ + "pattern_id" + ], + "properties": { + "pattern_id": { + "type": "integer", + "description": "The ID of the custom pattern to delete." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + } + }, + "post_delete_action": { + "type": "string", + "description": "What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.", + "enum": [ + "delete_alerts", + "resolve_alerts" + ], + "default": "delete_alerts" + } + } + }, + "examples": { + "default": { + "value": { + "patterns": [ + { + "pattern_id": 2, + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "All patterns deleted successfully." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": { + "patch": { + "summary": "Update a repository custom pattern", + "description": "Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-repo-custom-pattern", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "custom-patterns" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pattern_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The ID of the custom pattern." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern To Update", + "description": "Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.", + "required": [ + "custom_pattern_version" + ], + "anyOf": [ + { + "required": [ + "pattern" + ] + }, + { + "required": [ + "start_delimiter" + ] + }, + { + "required": [ + "end_delimiter" + ] + }, + { + "required": [ + "must_match" + ] + }, + { + "required": [ + "must_not_match" + ] + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "The updated regular expression of the custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The updated start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": "string", + "description": "The updated end delimiter regex for the custom pattern." + }, + "must_match": { + "type": "array", + "description": "Updated list of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "Updated list of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "pattern": "updated_secret_[0-9A-Z]{16}", + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pattern updated successfully.", + "content": { + "application/json": { + "schema": { + "title": "Secret Scanning Custom Pattern", + "description": "A custom pattern for secret scanning.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the custom pattern." + }, + "name": { + "type": "string", + "description": "The name of the custom pattern." + }, + "pattern": { + "type": "string", + "description": "The regular expression of the custom pattern." + }, + "slug": { + "type": "string", + "description": "A URL-friendly identifier for the custom pattern, derived from its name." + }, + "state": { + "type": "string", + "description": "The state of the custom pattern.", + "enum": [ + "published", + "unpublished" + ] + }, + "push_protection_enabled": { + "type": "boolean", + "description": "Whether push protection is enabled for this custom pattern." + }, + "start_delimiter": { + "type": "string", + "description": "The start delimiter regex for the custom pattern.", + "nullable": true + }, + "end_delimiter": { + "type": "string", + "description": "The end delimiter regex for the custom pattern.", + "nullable": true + }, + "must_match": { + "type": "array", + "description": "List of regexes that the secret must match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": "array", + "description": "List of regexes that the secret must not match.", + "nullable": true, + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was created in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the custom pattern was last updated in ISO 8601 format." + } + }, + "required": [ + "id", + "name", + "pattern", + "slug", + "state", + "push_protection_enabled" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "name": "Example Custom Pattern", + "pattern": "updated_secret_[0-9A-Z]{16}", + "slug": "example_custom_pattern", + "state": "published", + "push_protection_enabled": true, + "start_delimiter": "[^0-9A-Za-z]", + "end_delimiter": "[^0-9A-Za-z]", + "must_match": [ + "updated_secret_[0-9]{2}*" + ], + "must_not_match": [ + "updated_secret_1234567890ABCDEF" + ], + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "created_at": "2024-01-15T10:30:00Z", + "updated_at": "2024-06-01T12:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "412": { + "description": "Precondition Failed", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -656831,7 +659703,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -741718,7 +744590,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -938516,7 +941388,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -941164,7 +944036,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -943719,7 +946591,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -946274,7 +949146,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -948961,7 +951833,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -951655,7 +954527,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", @@ -956011,7 +958883,7 @@ "permissions": { "title": "App Permissions", "type": "object", - "description": "The permissions granted to the user access token.", + "description": "The permissions granted to the fine-grained access token.", "properties": { "actions": { "type": "string", diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 0a76619a5d..7b64983389 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -888,7 +888,7 @@ paths: - subscriptions_url - type - url - type: &347 + type: &349 type: string description: The type of credit the user is receiving. enum: @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &702 + - &717 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -4793,7 +4793,8 @@ paths: permissions: &24 title: App Permissions type: object - description: The permissions granted to the user access token. + description: The permissions granted to the fine-grained access + token. properties: actions: type: string @@ -6851,15 +6852,19 @@ paths: subcategory: apps "/assignments/{assignment_id}": get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. + summary: Closing down - Get an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment parameters: - &31 name: assignment_id @@ -7108,19 +7113,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/accepted_assignments": get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. + summary: Closing down - List accepted assignments for an assignment + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/list-accepted-assignments-for-an-assignment externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment parameters: - *31 - *19 @@ -7372,18 +7382,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/assignments/{assignment_id}/grades": get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. + summary: Closing down - Get assignment grades + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. tags: - classroom operationId: classroom/get-assignment-grades externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades parameters: - *31 responses: @@ -7473,18 +7489,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms": get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. + summary: Closing down - List classrooms + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. tags: - classroom operationId: classroom/list-classrooms externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms parameters: - *19 - *17 @@ -7507,18 +7529,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}": get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - Get a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/get-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom parameters: - &35 name: classroom_id @@ -7552,18 +7580,24 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/classrooms/{classroom_id}/assignments": get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. + summary: Closing down - List assignments for a classroom + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed on August 28, 2026. + > For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset). + + Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. tags: - classroom operationId: classroom/list-assignments-for-a-classroom externalDocs: description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom parameters: - *35 - *19 @@ -7605,6 +7639,9 @@ paths: enabledForGitHubApps: true category: classroom subcategory: classroom + deprecationDate: '2026-05-22' + removalDate: '2026-08-28' + deprecated: true "/codes_of_conduct": get: summary: Get all codes of conduct @@ -12162,7 +12199,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &510 + - &512 name: has in: query description: |- @@ -12288,7 +12325,7 @@ paths: - direct - transitive - inconclusive - security_advisory: &511 + security_advisory: &513 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12576,14 +12613,14 @@ paths: format: date-time readOnly: true nullable: true - auto_dismissed_at: &512 + auto_dismissed_at: &514 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissal_request: &513 + dismissal_request: &515 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -14271,7 +14308,7 @@ paths: properties: action: type: string - discussion: &798 + discussion: &813 title: Discussion description: A Discussion in a repository. type: object @@ -14638,7 +14675,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &565 + properties: &567 id: type: integer format: int64 @@ -15016,7 +15053,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &713 + sub_issues_summary: &728 title: Sub-issues Summary type: object properties: @@ -15103,7 +15140,7 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: &592 + properties: &594 pinned_at: type: string format: date-time @@ -15115,7 +15152,7 @@ paths: properties: *20 required: *21 nullable: true - required: &593 + required: &595 - pinned_at - pinned_by nullable: true @@ -15124,13 +15161,13 @@ paths: description: Details about why an issue comment was minimized. type: object - properties: &594 + properties: &596 reason: description: The reason the comment was minimized. type: string nullable: true example: low-quality - required: &595 + required: &597 - reason nullable: true required: &90 @@ -15143,7 +15180,7 @@ paths: - created_at - updated_at nullable: true - issue_dependencies_summary: &714 + issue_dependencies_summary: &729 title: Issue Dependencies Summary type: object properties: @@ -15162,7 +15199,7 @@ paths: - total_blocking issue_field_values: type: array - items: &576 + items: &578 title: Issue Field Value description: A value assigned to an issue field type: object @@ -15254,7 +15291,7 @@ paths: - node_id - data_type - value - required: &566 + required: &568 - assignee - closed_at - comments @@ -15275,7 +15312,7 @@ paths: - user - created_at - updated_at - x-github-breaking-changes: &567 + x-github-breaking-changes: &569 - changeset: deprecate_beta_media_type patch: properties: @@ -15335,7 +15372,7 @@ paths: action: type: string issue: *88 - comment: &561 + comment: &563 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15999,7 +16036,7 @@ paths: type: string release: allOf: - - &639 + - &641 title: Release description: A release. type: object @@ -16070,7 +16107,7 @@ paths: author: *4 assets: type: array - items: &640 + items: &642 title: Release Asset description: Data related to a release. type: object @@ -16690,7 +16727,7 @@ paths: url: type: string format: uri - user: &722 + user: &737 title: Public User description: Public User type: object @@ -20017,14 +20054,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &356 + - &358 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &357 + - &359 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -20086,7 +20123,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &360 + '301': &362 description: Moved permanently content: application/json: @@ -20108,7 +20145,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &615 + - &617 name: all description: If `true`, show notifications marked as read. in: query @@ -20116,7 +20153,7 @@ paths: schema: type: boolean default: false - - &616 + - &618 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -20126,7 +20163,7 @@ paths: type: boolean default: false - *95 - - &617 + - &619 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -20662,7 +20699,7 @@ paths: - url - subscription_url examples: - default: &618 + default: &620 value: - id: '1' repository: @@ -22576,7 +22613,7 @@ paths: parameters: - *78 - *124 - - &774 + - &789 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -22688,7 +22725,7 @@ paths: - *124 - *125 - *126 - - &775 + - &790 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -22696,7 +22733,7 @@ paths: schema: type: string - *129 - - &776 + - &791 name: sku description: The SKU to query for usage. in: query @@ -23626,7 +23663,7 @@ paths: type: integer repository_cache_usages: type: array - items: &367 + items: &369 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -24968,7 +25005,7 @@ paths: - all - local_only - selected - selected_actions_url: &372 + selected_actions_url: &374 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -25051,7 +25088,7 @@ paths: description: Response content: application/json: - schema: &376 + schema: &378 type: object properties: days: @@ -25093,7 +25130,7 @@ paths: required: true content: application/json: - schema: &377 + schema: &379 type: object properties: days: @@ -25150,7 +25187,7 @@ paths: required: - approval_policy examples: - default: &378 + default: &380 value: approval_policy: first_time_contributors '404': *6 @@ -25209,7 +25246,7 @@ paths: description: Response content: application/json: - schema: &379 + schema: &381 type: object required: - run_workflows_from_fork_pull_requests @@ -25263,7 +25300,7 @@ paths: required: true content: application/json: - schema: &380 + schema: &382 type: object required: - run_workflows_from_fork_pull_requests @@ -25898,7 +25935,7 @@ paths: description: Response content: application/json: - schema: &381 + schema: &383 type: object properties: default_workflow_permissions: &156 @@ -25949,7 +25986,7 @@ paths: required: false content: application/json: - schema: &382 + schema: &384 type: object properties: default_workflow_permissions: *156 @@ -27089,7 +27126,7 @@ paths: application/json: schema: type: array - items: &383 + items: &385 title: Runner Application description: Runner Application type: object @@ -27114,7 +27151,7 @@ paths: - download_url - filename examples: - default: &384 + default: &386 value: - os: osx architecture: x64 @@ -27200,7 +27237,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &385 + '201': &387 description: Response content: application/json: @@ -27311,7 +27348,7 @@ paths: - token - expires_at examples: - default: &386 + default: &388 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -27350,7 +27387,7 @@ paths: application/json: schema: *167 examples: - default: &387 + default: &389 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -27384,7 +27421,7 @@ paths: application/json: schema: *165 examples: - default: &388 + default: &390 value: id: 23 name: MBP @@ -27611,7 +27648,7 @@ paths: - *78 - *164 responses: - '200': &389 + '200': &391 description: Response content: application/json: @@ -27668,7 +27705,7 @@ paths: parameters: - *78 - *164 - - &390 + - &392 name: name description: The name of a self-hosted runner's custom label. in: path @@ -30237,12 +30274,12 @@ paths: required: - subject_digests examples: - default: &755 + default: &770 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &756 + withPredicateType: &771 value: subject_digests: - sha256:abc123 @@ -30300,7 +30337,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &757 + default: &772 value: attestations_subject_digests: - sha256:abc: @@ -30665,7 +30702,7 @@ paths: initiator: type: string examples: - default: &416 + default: &418 value: attestations: - bundle: @@ -31619,7 +31656,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *78 - - &443 + - &445 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, @@ -31629,7 +31666,7 @@ paths: schema: &195 type: string description: The name of the tool used to generate the code scanning analysis. - - &444 + - &446 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -31652,7 +31689,7 @@ paths: be returned. in: query required: false - schema: &446 + schema: &448 type: string description: State of a code scanning alert. enum: @@ -31675,7 +31712,7 @@ paths: be returned. in: query required: false - schema: &447 + schema: &449 type: string description: Severity of a code scanning alert. enum: @@ -31709,7 +31746,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: &448 + instances_url: &450 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -31732,7 +31769,7 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: &449 + dismissed_reason: &451 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -31741,13 +31778,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &450 + dismissed_comment: &452 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &451 + rule: &453 type: object properties: id: @@ -31800,7 +31837,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &452 + tool: &454 type: object properties: name: *195 @@ -31810,26 +31847,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *196 - most_recent_instance: &453 + most_recent_instance: &455 type: object properties: - ref: &445 + ref: &447 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &463 + analysis_key: &465 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. - environment: &464 + environment: &466 type: string description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &465 + category: &467 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -31849,7 +31886,7 @@ paths: with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. - location: &466 + location: &468 type: object description: Describe a region within a file for the alert. properties: @@ -31870,7 +31907,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: &467 + items: &469 type: string description: A classification of the file. For example to identify it as generated. @@ -33201,7 +33238,7 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &479 + properties: &481 name: type: string description: The name of the machine. @@ -33243,7 +33280,7 @@ paths: - ready - in_progress nullable: true - required: &480 + required: &482 - name - display_name - operating_system @@ -34111,7 +34148,7 @@ paths: - updated_at - visibility examples: - default: &481 + default: &483 value: total_count: 2 secrets: @@ -34149,7 +34186,7 @@ paths: description: Response content: application/json: - schema: &482 + schema: &484 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -34178,7 +34215,7 @@ paths: - key_id - key examples: - default: &483 + default: &485 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34210,7 +34247,7 @@ paths: application/json: schema: *203 examples: - default: &485 + default: &487 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -37747,7 +37784,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &518 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -37764,7 +37801,7 @@ paths: - key_id - key examples: - default: &517 + default: &519 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39571,7 +39608,7 @@ paths: application/json: schema: *22 examples: - default: &554 + default: &556 value: id: 1 account: @@ -39796,7 +39833,7 @@ paths: required: true content: application/json: - schema: &555 + schema: &557 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -40602,7 +40639,7 @@ paths: type: array items: *258 examples: - default: &559 + default: &561 value: - id: 410 node_id: IT_kwDNAd3NAZo @@ -41131,7 +41168,7 @@ paths: application/json: schema: *263 examples: - default: &478 + default: &480 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -42397,7 +42434,7 @@ paths: parameters: - *78 - *270 - - &738 + - &753 name: repo_name description: repo_name parameter in: path @@ -43162,7 +43199,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &348 + items: &350 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -43456,7 +43493,7 @@ paths: - nuget - container - *78 - - &739 + - &754 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -43497,7 +43534,7 @@ paths: default: *277 '403': *29 '401': *25 - '400': &741 + '400': &756 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -45594,7 +45631,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &830 + properties: &845 id: type: number description: The unique identifier of the status update. @@ -45642,7 +45679,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &831 + required: &846 - id - node_id - created_at @@ -45856,7 +45893,7 @@ paths: content: oneOf: - *88 - - &495 + - &497 title: Pull Request Simple description: Pull Request Simple type: object @@ -46082,7 +46119,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: &625 + auto_merge: &627 title: Auto merge description: The status of auto merging a pull request. type: object @@ -46532,7 +46569,7 @@ paths: - updated_at - project_url examples: - default: &761 + default: &776 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46709,7 +46746,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &762 + items: &777 type: object properties: name: @@ -46746,7 +46783,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &763 + iteration_configuration: &778 type: object description: The configuration for iteration fields. properties: @@ -46796,7 +46833,7 @@ paths: value: name: Due date data_type: date - single_select_field: &764 + single_select_field: &779 summary: Create a single select field value: name: Priority @@ -46823,7 +46860,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &765 + iteration_field: &780 summary: Create an iteration field value: name: Sprint @@ -46849,7 +46886,7 @@ paths: application/json: schema: *298 examples: - text_field: &766 + text_field: &781 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -46858,7 +46895,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-05-15T08:00:00Z' updated_at: '2022-05-15T08:00:00Z' - number_field: &767 + number_field: &782 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -46867,7 +46904,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-01T14:30:00Z' updated_at: '2022-06-01T14:30:00Z' - date_field: &768 + date_field: &783 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -46876,7 +46913,7 @@ paths: project_url: https://api.github.com/projects/67890 created_at: '2022-06-10T09:15:00Z' updated_at: '2022-06-10T09:15:00Z' - single_select_field: &769 + single_select_field: &784 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -46910,7 +46947,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &770 + iteration_field: &785 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -46956,7 +46993,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *294 - - &771 + - &786 name: field_id description: The unique identifier of the field. in: path @@ -46971,7 +47008,7 @@ paths: application/json: schema: *298 examples: - default: &772 + default: &787 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48168,7 +48205,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &752 + schema: &767 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -48345,7 +48382,7 @@ paths: parameters: - *294 - *78 - - &773 + - &788 name: view_number description: The number that identifies the project view. in: path @@ -49282,7 +49319,7 @@ paths: description: Response content: application/json: - schema: &359 + schema: &361 title: Full Repository description: Full Repository type: object @@ -49687,7 +49724,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &500 + properties: &502 url: type: string format: uri @@ -49703,7 +49740,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &501 + required: &503 - url - key - name @@ -49803,7 +49840,7 @@ paths: has_downloads: version: '2026-03-10' examples: - default: &361 + default: &363 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -50336,7 +50373,7 @@ paths: - *78 - *17 - *19 - - &648 + - &650 name: targets description: | A comma-separated list of rule targets to filter by. @@ -50618,7 +50655,7 @@ paths: - repository_property rules: type: array - items: &649 + items: &651 title: Repository Rule type: object description: A repository rule. @@ -50680,7 +50717,7 @@ paths: type: string enum: - required_linear_history - - &646 + - &648 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -51319,7 +51356,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &647 + - &649 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -51631,7 +51668,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *78 - - &650 + - &652 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -51646,7 +51683,7 @@ paths: in: query schema: type: string - - &651 + - &653 name: time_period description: |- The time period to filter by. @@ -51662,14 +51699,14 @@ paths: - week - month default: day - - &652 + - &654 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &653 + - &655 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -51682,7 +51719,7 @@ paths: - bypass - all default: all - - &654 + - &656 name: evaluate_status description: |- The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. @@ -51705,7 +51742,7 @@ paths: description: Response content: application/json: - schema: &655 + schema: &657 title: Rule Suites description: Response type: array @@ -51760,7 +51797,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &656 + default: &658 value: - id: 21 actor_id: 12 @@ -51804,7 +51841,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *78 - - &657 + - &659 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -51820,7 +51857,7 @@ paths: description: Response content: application/json: - schema: &658 + schema: &660 title: Rule Suite description: Response type: object @@ -51919,7 +51956,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &659 + default: &661 value: id: 21 actor_id: 12 @@ -52166,7 +52203,7 @@ paths: type: string format: date-time examples: - default: &661 + default: &663 value: - version_id: 3 actor: @@ -52219,7 +52256,7 @@ paths: description: Response content: application/json: - schema: &662 + schema: &664 allOf: - *344 - type: object @@ -52291,7 +52328,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *78 - - &663 + - &665 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -52302,7 +52339,7 @@ paths: enum: - open - resolved - - &664 + - &666 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -52312,7 +52349,7 @@ paths: required: false schema: type: string - - &665 + - &667 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -52323,7 +52360,7 @@ paths: required: false schema: type: string - - &666 + - &668 name: exclude_providers in: query description: |- @@ -52334,7 +52371,7 @@ paths: required: false schema: type: string - - &667 + - &669 name: providers in: query description: |- @@ -52345,7 +52382,7 @@ paths: required: false schema: type: string - - &668 + - &670 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -52354,7 +52391,7 @@ paths: required: false schema: type: string - - &669 + - &671 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -52373,7 +52410,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &670 + - &672 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -52388,7 +52425,7 @@ paths: - *62 - *19 - *17 - - &671 + - &673 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -52398,7 +52435,7 @@ paths: required: false schema: type: string - - &672 + - &674 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -52408,7 +52445,7 @@ paths: required: false schema: type: string - - &673 + - &675 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -52417,7 +52454,7 @@ paths: required: false schema: type: string - - &674 + - &676 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -52426,7 +52463,7 @@ paths: schema: type: boolean default: false - - &675 + - &677 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -52435,7 +52472,7 @@ paths: schema: type: boolean default: false - - &676 + - &678 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -52444,7 +52481,7 @@ paths: schema: type: boolean default: false - - &677 + - &679 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -52455,7 +52492,7 @@ paths: required: false schema: type: boolean - - &678 + - &680 name: included_metadata in: query description: |- @@ -52466,7 +52503,7 @@ paths: required: false schema: type: string - - &679 + - &681 name: owner_email_hash in: query description: |- @@ -52504,14 +52541,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &680 + state: &682 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &681 + resolution: &683 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -52628,8 +52665,8 @@ paths: pull request. ' - oneOf: &682 - - &684 + oneOf: &684 + - &686 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -52687,7 +52724,7 @@ paths: - blob_url - commit_sha - commit_url - - &685 + - &687 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -52742,7 +52779,7 @@ paths: - page_url - commit_sha - commit_url - - &686 + - &688 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -52762,7 +52799,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &687 + - &689 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -52782,7 +52819,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &688 + - &690 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -52802,7 +52839,7 @@ paths: example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &689 + - &691 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -52816,7 +52853,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &690 + - &692 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -52830,7 +52867,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &691 + - &693 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -52844,7 +52881,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &692 + - &694 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -52864,7 +52901,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &693 + - &695 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -52884,7 +52921,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &694 + - &696 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -52904,7 +52941,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &695 + - &697 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -52924,7 +52961,7 @@ paths: example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &696 + - &698 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -53156,6 +53193,526 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/custom-patterns": + get: + summary: List organization custom patterns + description: |- + Lists secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - &699 + name: state + description: Filter custom patterns by state. When absent, returns patterns + in all states. + in: query + required: false + schema: + type: string + enum: + - published + - unpublished + - &700 + name: push_protection + description: Filter custom patterns by whether push protection is enabled. + When absent, returns patterns regardless of push protection status. + in: query + required: false + schema: + type: string + enum: + - enabled + - disabled + - &701 + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &345 + title: Secret Scanning Custom Pattern + description: A custom pattern for secret scanning. + type: object + properties: + id: + type: integer + description: The ID of the custom pattern. + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + slug: + type: string + description: A URL-friendly identifier for the custom pattern, + derived from its name. + state: + type: string + description: The state of the custom pattern. + enum: + - published + - unpublished + push_protection_enabled: + type: boolean + description: Whether push protection is enabled for this custom + pattern. + start_delimiter: + type: string + description: The start delimiter regex for the custom pattern. + nullable: true + end_delimiter: + type: string + description: The end delimiter regex for the custom pattern. + nullable: true + must_match: + type: array + description: List of regexes that the secret must match. + nullable: true + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + nullable: true + items: + type: string + custom_pattern_version: &346 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + created_at: + type: string + format: date-time + description: The date and time the custom pattern was created + in ISO 8601 format. + updated_at: + type: string + format: date-time + description: The date and time the custom pattern was last updated + in ISO 8601 format. + required: + - id + - name + - pattern + - slug + - state + - push_protection_enabled + examples: + default: &702 + value: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: published + push_protection_enabled: true + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: published + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-16T14:20:00Z' + updated_at: '2024-01-17T09:15:00Z' + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create organization custom patterns + description: |- + Bulk creates secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: &703 + title: Secret Scanning Custom Pattern To Create + description: A custom pattern to create in a bulk operation. + type: object + required: + - name + - pattern + properties: + name: + type: string + description: The name of the custom pattern. + pattern: + type: string + description: The regular expression of the custom pattern. + start_delimiter: + type: string + description: |- + The start delimiter regex for the custom pattern. + Defaults to `\A|[^0-9A-Za-z]` when not specified. + default: "\\A|[^0-9A-Za-z]" + end_delimiter: + type: string + description: |- + The end delimiter regex for the custom pattern. + Defaults to `\z|[^0-9A-Za-z]` when not specified. + default: "\\z|[^0-9A-Za-z]" + must_match: + type: array + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: List of regexes that the secret must not match. + items: + type: string + examples: + default: &704 + value: + patterns: + - name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + - name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *345 + examples: + default: &705 + value: + created_patterns: + - id: 1 + name: Example Custom Pattern + pattern: "[a-z]+_token_[0-9]+" + slug: example-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: + end_delimiter: + must_match: + must_not_match: + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + - id: 2 + name: Another Custom Pattern + pattern: prefix_[a-zA-Z0-9]{32} + slug: another-custom-pattern + state: unpublished + push_protection_enabled: false + start_delimiter: "\\b" + end_delimiter: "\\b" + must_match: + - "^prefix_prod" + must_not_match: + - test + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-01-15T10:30:00Z' + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: &706 + title: Secret Scanning Custom Pattern Validation Error + description: A validation error for a custom pattern in + a batch operation. + type: object + properties: + code: + type: string + description: A machine-readable code describing the + error. + enum: + - none + - config_load + - compile_db + - start_delimiter + - end_delimiter + - display_name + - must_match + - must_not_match + - custom_pattern_version_mismatch + - db_size + - db_size_calculation + message: + type: string + description: A human-readable description of the error. + delete: + summary: Bulk delete organization custom patterns + description: |- + Bulk deletes secret scanning custom patterns for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-org-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: &707 + title: Secret Scanning Custom Pattern To Delete + description: A custom pattern to delete in a bulk operation. + type: object + required: + - pattern_id + properties: + pattern_id: + type: integer + description: The ID of the custom pattern to delete. + custom_pattern_version: *346 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: &708 + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': &347 + description: Precondition Failed + content: + application/json: + schema: *3 + "/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update an organization custom pattern + description: |- + Updates a secret scanning custom pattern for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *78 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: &709 + title: Secret Scanning Custom Pattern To Update + description: Fields to update on a custom pattern. At least one updatable + field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, + or `must_not_match`) must also be provided. Only provided fields will + be updated. + required: + - custom_pattern_version + anyOf: + - required: + - pattern + - required: + - start_delimiter + - required: + - end_delimiter + - required: + - must_match + - required: + - must_not_match + properties: + pattern: + type: string + description: The updated regular expression of the custom pattern. + start_delimiter: + type: string + description: The updated start delimiter regex for the custom pattern. + end_delimiter: + type: string + description: The updated end delimiter regex for the custom pattern. + must_match: + type: array + description: Updated list of regexes that the secret must match. + items: + type: string + must_not_match: + type: array + description: Updated list of regexes that the secret must not match. + items: + type: string + custom_pattern_version: *346 + examples: + default: &710 + value: + pattern: updated_secret_[0-9A-Z]{16} + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *345 + examples: + default: &711 + value: + id: 1 + name: Example Custom Pattern + pattern: updated_secret_[0-9A-Z]{16} + slug: example_custom_pattern + state: published + push_protection_enabled: true + start_delimiter: "[^0-9A-Za-z]" + end_delimiter: "[^0-9A-Za-z]" + must_match: + - updated_secret_[0-9]{2}* + must_not_match: + - updated_secret_1234567890ABCDEF + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + created_at: '2024-01-15T10:30:00Z' + updated_at: '2024-06-01T12:00:00Z' + '400': *14 + '403': *29 + '404': *6 + '412': *347 + '422': *15 "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -53187,16 +53744,11 @@ paths: related to push protection. type: object properties: - pattern_config_version: &346 - type: string - description: The version of the entity. This is used to confirm - you're updating the current version of the entity and mitigate - unintentionally overriding someone else's update. - nullable: true + pattern_config_version: *346 provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &345 + items: &348 type: object properties: token_type: @@ -53262,7 +53814,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *345 + items: *348 examples: default: value: @@ -53443,7 +53995,7 @@ paths: application/json: schema: type: array - items: &700 + items: &715 description: A repository security advisory. type: object properties: @@ -53663,7 +54215,7 @@ paths: login: type: string description: The username of the user credited. - type: *347 + type: *349 credits_detailed: type: array nullable: true @@ -53673,7 +54225,7 @@ paths: type: object properties: user: *4 - type: *347 + type: *349 state: type: string description: The state of the user's acceptance of the @@ -53766,7 +54318,7 @@ paths: - private_fork version: '2026-03-10' examples: - default: &701 + default: &716 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54153,7 +54705,7 @@ paths: application/json: schema: type: array - items: *348 + items: *350 examples: default: value: @@ -54506,7 +55058,7 @@ paths: type: integer network_configurations: type: array - items: &349 + items: &351 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -54652,9 +55204,9 @@ paths: description: Response content: application/json: - schema: *349 + schema: *351 examples: - default: &350 + default: &352 value: id: 123456789ABCDEF name: My network configuration @@ -54683,7 +55235,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - &351 + - &353 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -54695,9 +55247,9 @@ paths: description: Response content: application/json: - schema: *349 + schema: *351 examples: - default: *350 + default: *352 headers: Link: *70 x-github: @@ -54719,7 +55271,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *78 - - *351 + - *353 requestBody: required: true content: @@ -54772,9 +55324,9 @@ paths: description: Response content: application/json: - schema: *349 + schema: *351 examples: - default: *350 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54794,7 +55346,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *78 - - *351 + - *353 responses: '204': description: Response @@ -55007,7 +55559,7 @@ paths: description: Response content: application/json: - schema: &352 + schema: &354 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55334,7 +55886,7 @@ paths: - repos_count - organization examples: - default: &353 + default: &355 value: id: 1 node_id: MDQ6VGVhbTE= @@ -55422,9 +55974,9 @@ paths: description: Response content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '404': *6 x-github: githubCloudOnly: false @@ -55508,16 +56060,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '201': description: Response content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '404': *6 '422': *15 '403': *29 @@ -55547,7 +56099,7 @@ paths: responses: '204': description: Response - '422': &354 + '422': &356 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -55586,7 +56138,7 @@ paths: default: *253 headers: Link: *70 - '422': *354 + '422': *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55630,7 +56182,7 @@ paths: application/json: schema: type: array - items: &716 + items: &731 title: Team Member description: A user that is a member of a team, including their role on the team and whether the membership is inherited from @@ -55749,7 +56301,7 @@ paths: - type - url examples: - default: &717 + default: &732 value: - login: octocat id: 1 @@ -55808,7 +56360,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &357 title: Team Membership description: Team Membership type: object @@ -55835,7 +56387,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &718 + response-if-user-is-a-team-maintainer: &733 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -55898,9 +56450,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *357 examples: - response-if-users-membership-with-team-is-now-pending: &719 + response-if-users-membership-with-team-is-now-pending: &734 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56007,14 +56559,14 @@ paths: parameters: - *78 - *80 - - *356 - - *357 + - *358 + - *359 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &720 + schema: &735 title: Team Repository description: A team's access to a repository. type: object @@ -56670,8 +57222,8 @@ paths: parameters: - *78 - *80 - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -56718,8 +57270,8 @@ paths: parameters: - *78 - *80 - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -56756,7 +57308,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: &721 + response-if-child-teams-exist: &736 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -56909,7 +57461,7 @@ paths: resources: type: object properties: - core: &358 + core: &360 title: Rate Limit type: object properties: @@ -56926,21 +57478,21 @@ paths: - remaining - reset - used - graphql: *358 - search: *358 - code_search: *358 - source_import: *358 - integration_manifest: *358 - actions_runner_registration: *358 - scim: *358 - dependency_snapshots: *358 - dependency_sbom: *358 - code_scanning_autofix: *358 - copilot_usage_records: *358 + graphql: *360 + search: *360 + code_search: *360 + source_import: *360 + integration_manifest: *360 + actions_runner_registration: *360 + scim: *360 + dependency_snapshots: *360 + dependency_sbom: *360 + code_scanning_autofix: *360 + copilot_usage_records: *360 required: - core - search - rate: *358 + rate: *360 required: - rate - resources @@ -57054,14 +57606,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *359 + schema: *361 examples: default-response: summary: Default response @@ -57572,7 +58124,7 @@ paths: version: '2026-03-10' '403': *29 '404': *6 - '301': *360 + '301': *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57590,8 +58142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -57901,10 +58453,10 @@ paths: description: Response content: application/json: - schema: *359 + schema: *361 examples: - default: *361 - '307': &362 + default: *363 + '307': &364 description: Temporary Redirect content: application/json: @@ -57933,8 +58485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -57956,7 +58508,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *362 + '307': *364 '404': *6 '409': *54 x-github: @@ -57980,11 +58532,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 - - &394 + - &396 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -58007,7 +58559,7 @@ paths: type: integer artifacts: type: array - items: &363 + items: &365 title: Artifact description: An artifact type: object @@ -58085,7 +58637,7 @@ paths: - expires_at - updated_at examples: - default: &395 + default: &397 value: total_count: 2 artifacts: @@ -58146,9 +58698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *356 - - *357 - - &364 + - *358 + - *359 + - &366 name: artifact_id description: The unique identifier of the artifact. in: path @@ -58160,7 +58712,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *365 examples: default: value: @@ -58198,9 +58750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *356 - - *357 - - *364 + - *358 + - *359 + - *366 responses: '204': description: Response @@ -58224,9 +58776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *356 - - *357 - - *364 + - *358 + - *359 + - *366 - name: archive_format in: path required: true @@ -58236,11 +58788,11 @@ paths: '302': description: Response headers: - Location: &519 + Location: &521 example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': &560 + '410': &562 description: Gone content: application/json: @@ -58265,14 +58817,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: &365 + schema: &367 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -58305,13 +58857,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *365 + schema: *367 examples: selected_actions: *42 responses: @@ -58340,14 +58892,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: &366 + schema: &368 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -58380,13 +58932,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *366 + schema: *368 examples: selected_actions: *44 responses: @@ -58417,14 +58969,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *367 + schema: *369 examples: default: value: @@ -58450,11 +59002,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 - - &368 + - &370 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -58488,7 +59040,7 @@ paths: description: Response content: application/json: - schema: &369 + schema: &371 title: Repository actions caches description: Repository actions caches type: object @@ -58530,7 +59082,7 @@ paths: - total_count - actions_caches examples: - default: &370 + default: &372 value: total_count: 1 actions_caches: @@ -58562,23 +59114,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *356 - - *357 + - *358 + - *359 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *368 + - *370 responses: '200': description: Response content: application/json: - schema: *369 + schema: *371 examples: - default: *370 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58598,8 +59150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *356 - - *357 + - *358 + - *359 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -58628,8 +59180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *48 responses: @@ -58711,8 +59263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: concurrency_group_name description: The name of the concurrency group. in: path @@ -58864,9 +59416,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *356 - - *357 - - &371 + - *358 + - *359 + - &373 name: job_id description: The unique identifier of the job. in: path @@ -58878,7 +59430,7 @@ paths: description: Response content: application/json: - schema: &398 + schema: &400 title: Job description: Information of a job execution in a workflow run type: object @@ -59185,9 +59737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *356 - - *357 - - *371 + - *358 + - *359 + - *373 responses: '302': description: Response @@ -59215,9 +59767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *356 - - *357 - - *371 + - *358 + - *359 + - *373 requestBody: required: false content: @@ -59267,8 +59819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Status response @@ -59327,8 +59879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -59396,8 +59948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -59415,7 +59967,7 @@ paths: type: integer secrets: type: array - items: &400 + items: &402 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -59435,7 +59987,7 @@ paths: - created_at - updated_at examples: - default: &401 + default: &403 value: total_count: 2 secrets: @@ -59468,8 +60020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *356 - - *357 + - *358 + - *359 - *180 - *19 responses: @@ -59487,7 +60039,7 @@ paths: type: integer variables: type: array - items: &402 + items: &404 title: Actions Variable type: object properties: @@ -59517,7 +60069,7 @@ paths: - created_at - updated_at examples: - default: &403 + default: &405 value: total_count: 2 variables: @@ -59550,8 +60102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -59560,11 +60112,11 @@ paths: schema: type: object properties: - enabled: &373 + enabled: &375 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *148 - selected_actions_url: *372 + selected_actions_url: *374 sha_pinning_required: *149 required: - enabled @@ -59593,8 +60145,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -59605,7 +60157,7 @@ paths: schema: type: object properties: - enabled: *373 + enabled: *375 allowed_actions: *148 sha_pinning_required: *149 required: @@ -59637,14 +60189,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: &374 + schema: &376 type: object properties: access_level: @@ -59661,7 +60213,7 @@ paths: required: - access_level examples: - default: &375 + default: &377 value: access_level: organization x-github: @@ -59685,15 +60237,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *374 + schema: *376 examples: - default: *375 + default: *377 responses: '204': description: Response @@ -59717,14 +60269,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *376 + schema: *378 examples: default: value: @@ -59748,8 +60300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Empty response for successful settings update @@ -59759,7 +60311,7 @@ paths: required: true content: application/json: - schema: *377 + schema: *379 examples: default: summary: Set retention days @@ -59783,8 +60335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -59792,7 +60344,7 @@ paths: application/json: schema: *150 examples: - default: *378 + default: *380 '404': *6 x-github: enabledForGitHubApps: true @@ -59811,8 +60363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -59846,14 +60398,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *379 + schema: *381 examples: default: *151 '403': *29 @@ -59875,13 +60427,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *380 + schema: *382 examples: default: *151 responses: @@ -59907,8 +60459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -59935,8 +60487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -59968,14 +60520,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: default: *158 x-github: @@ -59998,8 +60550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Success response @@ -60010,7 +60562,7 @@ paths: required: true content: application/json: - schema: *382 + schema: *384 examples: default: *158 x-github: @@ -60039,8 +60591,8 @@ paths: in: query schema: type: string - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -60084,8 +60636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -60093,9 +60645,9 @@ paths: application/json: schema: type: array - items: *383 + items: *385 examples: - default: *384 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60117,8 +60669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -60161,7 +60713,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *385 + '201': *387 '404': *6 '422': *7 '409': *54 @@ -60192,8 +60744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '201': description: Response @@ -60201,7 +60753,7 @@ paths: application/json: schema: *167 examples: - default: *386 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60229,8 +60781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '201': description: Response @@ -60238,7 +60790,7 @@ paths: application/json: schema: *167 examples: - default: *387 + default: *389 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60260,8 +60812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 responses: '200': @@ -60270,7 +60822,7 @@ paths: application/json: schema: *165 examples: - default: *388 + default: *390 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60291,8 +60843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 responses: '204': @@ -60319,8 +60871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 responses: '200': *169 @@ -60345,8 +60897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 requestBody: required: true @@ -60395,8 +60947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 requestBody: required: true @@ -60446,11 +60998,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 responses: - '200': *389 + '200': *391 '404': *6 x-github: githubCloudOnly: false @@ -60477,10 +61029,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *164 - - *390 + - *392 responses: '200': *169 '404': *6 @@ -60508,9 +61060,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *356 - - *357 - - &406 + - *358 + - *359 + - &408 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -60518,7 +61070,7 @@ paths: required: false schema: type: string - - &407 + - &409 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -60526,7 +61078,7 @@ paths: required: false schema: type: string - - &408 + - &410 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -60535,7 +61087,7 @@ paths: required: false schema: type: string - - &409 + - &411 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -60562,7 +61114,7 @@ paths: - pending - *17 - *19 - - &410 + - &412 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -60571,7 +61123,7 @@ paths: schema: type: string format: date-time - - &391 + - &393 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -60580,13 +61132,13 @@ paths: schema: type: boolean default: false - - &411 + - &413 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &412 + - &414 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -60609,7 +61161,7 @@ paths: type: integer workflow_runs: type: array - items: &392 + items: &394 title: Workflow Run description: An invocation of a workflow type: object @@ -60757,7 +61309,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &436 + properties: &438 id: type: string description: SHA for the commit @@ -60808,7 +61360,7 @@ paths: - name - email nullable: true - required: &437 + required: &439 - id - tree_id - message @@ -60855,7 +61407,7 @@ paths: - workflow_url - pull_requests examples: - default: &413 + default: &415 value: total_count: 1 workflow_runs: @@ -61091,24 +61643,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *356 - - *357 - - &393 + - *358 + - *359 + - &395 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *391 + - *393 responses: '200': description: Response content: application/json: - schema: *392 + schema: *394 examples: - default: &396 + default: &398 value: id: 30433642 name: Build @@ -61349,9 +61901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '204': description: Response @@ -61374,9 +61926,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '200': description: Response @@ -61495,9 +62047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '201': description: Response @@ -61530,12 +62082,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 - *17 - *19 - - *394 + - *396 - *62 responses: '200': @@ -61552,9 +62104,9 @@ paths: type: integer artifacts: type: array - items: *363 + items: *365 examples: - default: *395 + default: *397 headers: Link: *70 x-github: @@ -61578,25 +62130,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *356 - - *357 - - *393 - - &397 + - *358 + - *359 + - *395 + - &399 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *391 + - *393 responses: '200': description: Response content: application/json: - schema: *392 + schema: *394 examples: - default: *396 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61619,10 +62171,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *356 - - *357 - - *393 - - *397 + - *358 + - *359 + - *395 + - *399 - *17 - *19 responses: @@ -61640,9 +62192,9 @@ paths: type: integer jobs: type: array - items: *398 + items: *400 examples: - default: &399 + default: &401 value: total_count: 1 jobs: @@ -61755,10 +62307,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *356 - - *357 - - *393 - - *397 + - *358 + - *359 + - *395 + - *399 responses: '302': description: Response @@ -61786,9 +62338,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '202': description: Response @@ -61834,9 +62386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 - *17 - *47 - *48 @@ -62007,9 +62559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 requestBody: required: true content: @@ -62076,9 +62628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '202': description: Response @@ -62111,9 +62663,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -62143,9 +62695,9 @@ paths: type: integer jobs: type: array - items: *398 + items: *400 examples: - default: *399 + default: *401 headers: Link: *70 x-github: @@ -62170,9 +62722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '302': description: Response @@ -62199,9 +62751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '204': description: Response @@ -62228,9 +62780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '200': description: Response @@ -62290,7 +62842,7 @@ paths: items: type: object properties: - type: &526 + type: &528 type: string description: The type of reviewer. enum: @@ -62375,9 +62927,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 requestBody: required: true content: @@ -62424,12 +62976,12 @@ paths: application/json: schema: type: array - items: &521 + items: &523 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: &792 + properties: &807 url: type: string format: uri @@ -62514,7 +63066,7 @@ paths: nullable: true properties: *83 required: *84 - required: &793 + required: &808 - id - node_id - sha @@ -62530,7 +63082,7 @@ paths: - created_at - updated_at examples: - default: &522 + default: &524 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -62586,9 +63138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 requestBody: required: false content: @@ -62632,9 +63184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 requestBody: required: false content: @@ -62687,9 +63239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *356 - - *357 - - *393 + - *358 + - *359 + - *395 responses: '200': description: Response @@ -62826,8 +63378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -62845,9 +63397,9 @@ paths: type: integer secrets: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -62872,8 +63424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -62903,17 +63455,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: &414 + default: &416 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -62939,8 +63491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 requestBody: required: true @@ -62998,8 +63550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '204': @@ -63025,8 +63577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *356 - - *357 + - *358 + - *359 - *180 - *19 responses: @@ -63044,9 +63596,9 @@ paths: type: integer variables: type: array - items: *402 + items: *404 examples: - default: *403 + default: *405 headers: Link: *70 x-github: @@ -63069,8 +63621,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -63122,17 +63674,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 responses: '200': description: Response content: application/json: - schema: *402 + schema: *404 examples: - default: &415 + default: &417 value: name: USERNAME value: octocat @@ -63158,8 +63710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 requestBody: required: true @@ -63202,8 +63754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 responses: '204': @@ -63229,8 +63781,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -63248,7 +63800,7 @@ paths: type: integer workflows: type: array - items: &404 + items: &406 title: Workflow description: A GitHub Actions workflow type: object @@ -63355,9 +63907,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *356 - - *357 - - &405 + - *358 + - *359 + - &407 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -63372,7 +63924,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *406 examples: default: value: @@ -63405,9 +63957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *356 - - *357 - - *405 + - *358 + - *359 + - *407 responses: '204': description: Response @@ -63432,9 +63984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *356 - - *357 - - *405 + - *358 + - *359 + - *407 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -63532,9 +64084,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *356 - - *357 - - *405 + - *358 + - *359 + - *407 responses: '204': description: Response @@ -63561,19 +64113,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *356 - - *357 - - *405 - - *406 + - *358 + - *359 - *407 - *408 - *409 - - *17 - - *19 - *410 - - *391 - *411 + - *17 + - *19 - *412 + - *393 + - *413 + - *414 responses: '200': description: Response @@ -63589,9 +64141,9 @@ paths: type: integer workflow_runs: type: array - items: *392 + items: *394 examples: - default: *413 + default: *415 headers: Link: *70 x-github: @@ -63623,9 +64175,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *356 - - *357 - - *405 + - *358 + - *359 + - *407 responses: '200': description: Response @@ -63686,8 +64238,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *356 - - *357 + - *358 + - *359 - *62 - *17 - *47 @@ -63856,8 +64408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-organization-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -63875,9 +64427,9 @@ paths: type: integer secrets: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -63901,8 +64453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-organization-variables parameters: - - *356 - - *357 + - *358 + - *359 - *180 - *19 responses: @@ -63920,9 +64472,9 @@ paths: type: integer variables: type: array - items: *402 + items: *404 examples: - default: *403 + default: *405 headers: Link: *70 x-github: @@ -63947,8 +64499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -63966,9 +64518,9 @@ paths: type: integer secrets: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -63993,8 +64545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-public-key parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -64024,17 +64576,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *414 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64056,8 +64608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#create-or-update-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 requestBody: required: true @@ -64115,8 +64667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#delete-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '204': @@ -64142,8 +64694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-variables parameters: - - *356 - - *357 + - *358 + - *359 - *180 - *19 responses: @@ -64161,9 +64713,9 @@ paths: type: integer variables: type: array - items: *402 + items: *404 examples: - default: *403 + default: *405 headers: Link: *70 x-github: @@ -64186,8 +64738,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#create-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -64239,17 +64791,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#get-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 responses: '200': description: Response content: application/json: - schema: *402 + schema: *404 examples: - default: *415 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64270,8 +64822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#update-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 requestBody: required: true @@ -64314,8 +64866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#delete-a-repository-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 responses: '204': @@ -64337,8 +64889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -64375,8 +64927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *356 - - *357 + - *358 + - *359 - name: assignee in: path required: true @@ -64412,8 +64964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -64523,8 +65075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *47 - *48 @@ -64581,7 +65133,7 @@ paths: initiator: type: string examples: - default: *416 + default: *418 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64615,8 +65167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -64624,7 +65176,7 @@ paths: application/json: schema: type: array - items: &417 + items: &419 title: Autolink reference description: An autolink reference. type: object @@ -64678,8 +65230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -64718,9 +65270,9 @@ paths: description: response content: application/json: - schema: *417 + schema: *419 examples: - default: &418 + default: &420 value: id: 1 key_prefix: TICKET- @@ -64751,9 +65303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *356 - - *357 - - &419 + - *358 + - *359 + - &421 name: autolink_id description: The unique identifier of the autolink. in: path @@ -64765,9 +65317,9 @@ paths: description: Response content: application/json: - schema: *417 + schema: *419 examples: - default: *418 + default: *420 '404': *6 x-github: githubCloudOnly: false @@ -64787,9 +65339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *356 - - *357 - - *419 + - *358 + - *359 + - *421 responses: '204': description: Response @@ -64813,8 +65365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response if Dependabot is enabled @@ -64862,8 +65414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -64884,8 +65436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -64905,8 +65457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *356 - - *357 + - *358 + - *359 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -64944,7 +65496,7 @@ paths: - url protected: type: boolean - protection: &421 + protection: &423 title: Branch Protection description: Branch Protection type: object @@ -64986,7 +65538,7 @@ paths: required: - contexts - checks - enforce_admins: &424 + enforce_admins: &426 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -65001,7 +65553,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &426 + required_pull_request_reviews: &428 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -65077,7 +65629,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &423 + restrictions: &425 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -65354,9 +65906,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *356 - - *357 - - &422 + - *358 + - *359 + - &424 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -65370,14 +65922,14 @@ paths: description: Response content: application/json: - schema: &432 + schema: &434 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &491 + commit: &493 title: Commit description: Commit type: object @@ -65411,7 +65963,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &420 + properties: &422 name: type: string example: '"Chris Wanstrath"' @@ -65427,7 +65979,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *420 + properties: *422 nullable: true message: type: string @@ -65448,7 +66000,7 @@ paths: required: - sha - url - verification: &544 + verification: &546 title: Verification type: object properties: @@ -65518,7 +66070,7 @@ paths: type: integer files: type: array - items: &504 + items: &506 title: Diff Entry description: Diff Entry type: object @@ -65602,7 +66154,7 @@ paths: - self protected: type: boolean - protection: *421 + protection: *423 protection_url: type: string format: uri @@ -65709,7 +66261,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *360 + '301': *362 '404': *6 x-github: githubCloudOnly: false @@ -65731,15 +66283,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *421 + schema: *423 examples: default: value: @@ -65933,9 +66485,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -66190,7 +66742,7 @@ paths: url: type: string format: uri - required_status_checks: &429 + required_status_checks: &431 title: Status Check Policy description: Status Check Policy type: object @@ -66342,7 +66894,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *423 + restrictions: *425 required_conversation_resolution: type: object properties: @@ -66454,9 +67006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -66481,17 +67033,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: &425 + default: &427 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -66513,17 +67065,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: *425 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66542,9 +67094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -66569,17 +67121,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *426 + schema: *428 examples: - default: &427 + default: &429 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -66675,9 +67227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -66775,9 +67327,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *428 examples: - default: *427 + default: *429 '422': *15 x-github: githubCloudOnly: false @@ -66798,9 +67350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -66827,17 +67379,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: &428 + default: &430 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -66860,17 +67412,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *424 + schema: *426 examples: - default: *428 + default: *430 '404': *6 x-github: githubCloudOnly: false @@ -66890,9 +67442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -66917,17 +67469,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *429 + schema: *431 examples: - default: &430 + default: &432 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -66953,9 +67505,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -67007,9 +67559,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *431 examples: - default: *430 + default: *432 '404': *6 '422': *15 x-github: @@ -67031,9 +67583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -67057,9 +67609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response @@ -67093,9 +67645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -67162,9 +67714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -67228,9 +67780,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: content: application/json: @@ -67296,15 +67848,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response content: application/json: - schema: *423 + schema: *425 examples: default: value: @@ -67395,9 +67947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '204': description: Response @@ -67420,9 +67972,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response @@ -67432,7 +67984,7 @@ paths: type: array items: *5 examples: - default: &431 + default: &433 value: - id: 1 slug: octoapp @@ -67489,9 +68041,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -67525,7 +68077,7 @@ paths: type: array items: *5 examples: - default: *431 + default: *433 '422': *15 x-github: githubCloudOnly: false @@ -67546,9 +68098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -67582,7 +68134,7 @@ paths: type: array items: *5 examples: - default: *431 + default: *433 '422': *15 x-github: githubCloudOnly: false @@ -67603,9 +68155,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -67639,7 +68191,7 @@ paths: type: array items: *5 examples: - default: *431 + default: *433 '422': *15 x-github: githubCloudOnly: false @@ -67661,9 +68213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response @@ -67693,9 +68245,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -67754,9 +68306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: false content: @@ -67815,9 +68367,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: content: application/json: @@ -67876,9 +68428,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 responses: '200': description: Response @@ -67912,9 +68464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -67972,9 +68524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -68032,9 +68584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -68094,9 +68646,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 requestBody: required: true content: @@ -68118,7 +68670,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *434 examples: default: value: @@ -68234,8 +68786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -68514,7 +69066,7 @@ paths: description: Response content: application/json: - schema: &433 + schema: &435 title: CheckRun description: A check performed on the code of a given code change type: object @@ -68634,7 +69186,7 @@ paths: check. type: array items: *93 - deployment: &785 + deployment: &800 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -68914,9 +69466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *356 - - *357 - - &434 + - *358 + - *359 + - &436 name: check_run_id description: The unique identifier of the check run. in: path @@ -68928,9 +69480,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *435 examples: - default: &435 + default: &437 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -69030,9 +69582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *356 - - *357 - - *434 + - *358 + - *359 + - *436 requestBody: required: true content: @@ -69272,9 +69824,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *435 examples: - default: *435 + default: *437 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69294,9 +69846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *356 - - *357 - - *434 + - *358 + - *359 + - *436 - *17 - *19 responses: @@ -69391,9 +69943,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *356 - - *357 - - *434 + - *358 + - *359 + - *436 responses: '201': description: Response @@ -69437,8 +69989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -69460,7 +70012,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &438 + schema: &440 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -69546,12 +70098,12 @@ paths: type: string format: date-time nullable: true - head_commit: &813 + head_commit: &828 title: Simple Commit description: A commit. type: object - properties: *436 - required: *437 + properties: *438 + required: *439 latest_check_runs_count: type: integer check_runs_url: @@ -69579,7 +70131,7 @@ paths: - check_runs_url - pull_requests examples: - default: &439 + default: &441 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -69870,9 +70422,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *438 + schema: *440 examples: - default: *439 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69891,8 +70443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -70201,9 +70753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *356 - - *357 - - &440 + - *358 + - *359 + - &442 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -70215,9 +70767,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *440 examples: - default: *439 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70240,17 +70792,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *356 - - *357 - - *440 - - &497 + - *358 + - *359 + - *442 + - &499 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &498 + - &500 name: status description: Returns check runs with the specified `status`. in: query @@ -70289,9 +70841,9 @@ paths: type: integer check_runs: type: array - items: *433 + items: *435 examples: - default: &499 + default: &501 value: total_count: 1 check_runs: @@ -70393,9 +70945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *356 - - *357 - - *440 + - *358 + - *359 + - *442 responses: '201': description: Response @@ -70424,8 +70976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *62 - *47 @@ -70447,7 +70999,7 @@ paths: application/json: schema: type: array - items: &441 + items: &443 description: Code quality finding type: object properties: @@ -70577,7 +71129,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': &442 + '403': &444 description: Response if the user is not authorized to access Code quality for this repository. content: @@ -70604,8 +71156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding parameters: - - *356 - - *357 + - *358 + - *359 - name: finding_number in: path description: The number that identifies a finding. @@ -70617,7 +71169,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *443 examples: default: value: @@ -70646,7 +71198,7 @@ paths: markdown: This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25). created_at: '2026-01-23T12:34:56Z' - '403': *442 + '403': *444 '404': *6 '503': *122 x-github: @@ -70668,8 +71220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -70733,7 +71285,7 @@ paths: runner_label: updated_at: '2023-01-01T00:00:00Z' schedule: weekly - '403': *442 + '403': *444 '404': *6 '503': *122 x-github: @@ -70754,8 +71306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -70883,21 +71435,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *356 - - *357 - - *443 - - *444 + - *358 + - *359 + - *445 + - *446 - *19 - *17 - - &461 + - &463 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *445 - - &462 + schema: *447 + - &464 name: pr description: The number of the pull request for the results you want to list. in: query @@ -70922,13 +71474,13 @@ paths: be returned. in: query required: false - schema: *446 + schema: *448 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *447 + schema: *449 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -70952,7 +71504,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *448 + instances_url: *450 state: *197 fixed_at: *193 dismissed_by: @@ -70963,11 +71515,11 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *449 - dismissed_comment: *450 - rule: *451 - tool: *452 - most_recent_instance: *453 + dismissed_reason: *451 + dismissed_comment: *452 + rule: *453 + tool: *454 + most_recent_instance: *455 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71093,7 +71645,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &454 + '403': &456 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -71120,9 +71672,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *356 - - *357 - - &455 + - *358 + - *359 + - &457 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -71136,7 +71688,7 @@ paths: description: Response content: application/json: - schema: &456 + schema: &458 type: object properties: number: *188 @@ -71144,7 +71696,7 @@ paths: updated_at: *190 url: *191 html_url: *192 - instances_url: *448 + instances_url: *450 state: *197 fixed_at: *193 dismissed_by: @@ -71155,8 +71707,8 @@ paths: required: *21 nullable: true dismissed_at: *194 - dismissed_reason: *449 - dismissed_comment: *450 + dismissed_reason: *451 + dismissed_comment: *452 rule: type: object properties: @@ -71210,8 +71762,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *452 - most_recent_instance: *453 + tool: *454 + most_recent_instance: *455 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -71310,7 +71862,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -71330,9 +71882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 requestBody: required: true content: @@ -71347,8 +71899,8 @@ paths: enum: - open - dismissed - dismissed_reason: *449 - dismissed_comment: *450 + dismissed_reason: *451 + dismissed_comment: *452 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -71376,7 +71928,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *458 examples: default: value: @@ -71452,7 +72004,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &460 + '403': &462 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -71479,15 +72031,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 responses: '200': description: Response content: application/json: - schema: &457 + schema: &459 type: object properties: status: @@ -71513,13 +72065,13 @@ paths: - description - started_at examples: - default: &458 + default: &460 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &459 + '400': &461 description: Bad Request content: application/json: @@ -71530,7 +72082,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *454 + '403': *456 '404': *6 '500': *55 x-github: @@ -71555,29 +72107,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 responses: '200': description: OK content: application/json: - schema: *457 + schema: *459 examples: - default: *458 + default: *460 '202': description: Accepted content: application/json: - schema: *457 + schema: *459 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *459 + '400': *461 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -71609,9 +72161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 requestBody: required: false content: @@ -71656,8 +72208,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *459 - '403': *460 + '400': *461 + '403': *462 '404': *6 '422': description: Unprocessable Entity @@ -71681,13 +72233,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 - *19 - *17 - - *461 - - *462 + - *463 + - *464 responses: '200': description: Response @@ -71698,10 +72250,10 @@ paths: items: type: object properties: - ref: *445 - analysis_key: *463 - environment: *464 - category: *465 + ref: *447 + analysis_key: *465 + environment: *466 + category: *467 state: type: string description: State of a code scanning alert instance. @@ -71716,7 +72268,7 @@ paths: properties: text: type: string - location: *466 + location: *468 html_url: type: string classifications: @@ -71724,7 +72276,7 @@ paths: description: |- Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file. - items: *467 + items: *469 examples: default: value: @@ -71761,7 +72313,7 @@ paths: end_column: 50 classifications: - source - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -71795,25 +72347,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *356 - - *357 - - *443 - - *444 + - *358 + - *359 + - *445 + - *446 - *19 - *17 - - *462 + - *464 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *445 + schema: *447 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &468 + schema: &470 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -71834,23 +72386,23 @@ paths: application/json: schema: type: array - items: &469 + items: &471 type: object properties: - ref: *445 - commit_sha: &477 + ref: *447 + commit_sha: &479 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 64 pattern: "^([0-9a-fA-F]{40}(?:[0-9a-fA-F]{24})?)$" - analysis_key: *463 + analysis_key: *465 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *465 + category: *467 error: type: string example: error reading field xyz @@ -71874,8 +72426,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *468 - tool: *452 + sarif_id: *470 + tool: *454 deletable: type: boolean warning: @@ -71936,7 +72488,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -71972,8 +72524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -71986,7 +72538,7 @@ paths: description: Response content: application/json: - schema: *469 + schema: *471 examples: response: summary: application/json response @@ -72040,7 +72592,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *454 + '403': *456 '404': *6 '422': description: Response if analysis could not be processed @@ -72127,8 +72679,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -72181,7 +72733,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *460 + '403': *462 '404': *6 '503': *122 x-github: @@ -72203,8 +72755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -72212,7 +72764,7 @@ paths: application/json: schema: type: array - items: &470 + items: &472 title: CodeQL Database description: A CodeQL database. type: object @@ -72323,7 +72875,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -72352,8 +72904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: language in: path description: The language of the CodeQL database. @@ -72365,7 +72917,7 @@ paths: description: Response content: application/json: - schema: *470 + schema: *472 examples: default: value: @@ -72397,9 +72949,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &508 + '302': &510 description: Found - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -72421,8 +72973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *356 - - *357 + - *358 + - *359 - name: language in: path description: The language of the CodeQL database. @@ -72432,7 +72984,7 @@ paths: responses: '204': description: Response - '403': *460 + '403': *462 '404': *6 '503': *122 x-github: @@ -72460,8 +73012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -72470,7 +73022,7 @@ paths: type: object additionalProperties: false properties: - language: &471 + language: &473 type: string description: The language targeted by the CodeQL query enum: @@ -72550,7 +73102,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &475 + schema: &477 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -72560,7 +73112,7 @@ paths: description: The ID of the variant analysis. controller_repo: *67 actor: *4 - query_language: *471 + query_language: *473 query_pack_url: type: string description: The download url for the query pack. @@ -72607,7 +73159,7 @@ paths: items: type: object properties: - repository: &472 + repository: &474 title: Repository Identifier description: Repository Identifier type: object @@ -72643,7 +73195,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &476 + analysis_status: &478 type: string description: The new status of the CodeQL variant analysis repository task. @@ -72675,7 +73227,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &473 + access_mismatch_repos: &475 type: object properties: repository_count: @@ -72689,7 +73241,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *472 + items: *474 required: - repository_count - repositories @@ -72711,8 +73263,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *473 - over_limit_repos: *473 + no_codeql_db_repos: *475 + over_limit_repos: *475 required: - access_mismatch_repos - not_found_repos @@ -72728,7 +73280,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &474 + value: &476 summary: Default response value: id: 1 @@ -72874,10 +73426,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *474 + value: *476 repository_lists: summary: Response for a successful variant analysis submission - value: *474 + value: *476 '404': *6 '422': description: Unable to process variant analysis submission @@ -72905,8 +73457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *356 - - *357 + - *358 + - *359 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -72918,9 +73470,9 @@ paths: description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: *474 + default: *476 '404': *6 '503': *122 x-github: @@ -72943,7 +73495,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *356 + - *358 - name: repo in: path description: The name of the controller repository. @@ -72978,7 +73530,7 @@ paths: type: object properties: repository: *67 - analysis_status: *476 + analysis_status: *478 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -73103,8 +73655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -73206,7 +73758,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *454 + '403': *456 '404': *6 '503': *122 x-github: @@ -73227,8 +73779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -73320,7 +73872,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *460 + '403': *462 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -73391,8 +73943,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -73400,7 +73952,7 @@ paths: schema: type: object properties: - commit_sha: *477 + commit_sha: *479 ref: type: string description: |- @@ -73458,7 +74010,7 @@ paths: schema: type: object properties: - id: *468 + id: *470 url: type: string description: The REST API URL for checking the status of the upload. @@ -73472,7 +74024,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *460 + '403': *462 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -73495,8 +74047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *356 - - *357 + - *358 + - *359 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -73542,7 +74094,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *454 + '403': *456 '404': description: Not Found if the sarif id does not match any upload '503': *122 @@ -73567,8 +74119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -73649,8 +74201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *356 - - *357 + - *358 + - *359 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -73770,8 +74322,8 @@ paths: parameters: - *17 - *19 - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -74085,8 +74637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -74151,7 +74703,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -74159,7 +74711,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '400': *14 '401': *25 '403': *29 @@ -74188,8 +74740,8 @@ paths: parameters: - *17 - *19 - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -74253,8 +74805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -74289,14 +74841,14 @@ paths: type: integer machines: type: array - items: &727 + items: &742 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *479 - required: *480 + properties: *481 + required: *482 examples: - default: &728 + default: &743 value: total_count: 2 machines: @@ -74336,8 +74888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *356 - - *357 + - *358 + - *359 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -74421,8 +74973,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *356 - - *357 + - *358 + - *359 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -74488,8 +75040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -74507,7 +75059,7 @@ paths: type: integer secrets: type: array - items: &484 + items: &486 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -74527,7 +75079,7 @@ paths: - created_at - updated_at examples: - default: *481 + default: *483 headers: Link: *70 x-github: @@ -74550,16 +75102,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *482 + schema: *484 examples: - default: *483 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -74579,17 +75131,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '200': description: Response content: application/json: - schema: *484 + schema: *486 examples: - default: *485 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74609,8 +75161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 requestBody: required: true @@ -74663,8 +75215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '204': @@ -74693,8 +75245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *356 - - *357 + - *358 + - *359 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -74736,7 +75288,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &486 + properties: &488 login: type: string example: octocat @@ -74829,7 +75381,7 @@ paths: user_view_type: type: string example: public - required: &487 + required: &489 - avatar_url - events_url - followers_url @@ -74903,8 +75455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *356 - - *357 + - *358 + - *359 - *74 responses: '204': @@ -74951,8 +75503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *356 - - *357 + - *358 + - *359 - *74 requestBody: required: false @@ -74979,7 +75531,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &558 + schema: &560 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -75208,8 +75760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *356 - - *357 + - *358 + - *359 - *74 responses: '204': @@ -75241,8 +75793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *356 - - *357 + - *358 + - *359 - *74 responses: '200': @@ -75263,8 +75815,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *486 - required: *487 + properties: *488 + required: *489 nullable: true required: - permission @@ -75319,8 +75871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -75330,7 +75882,7 @@ paths: application/json: schema: type: array - items: &488 + items: &490 title: Commit Comment description: Commit Comment type: object @@ -75388,7 +75940,7 @@ paths: - created_at - updated_at examples: - default: &493 + default: &495 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75447,17 +75999,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '200': description: Response content: application/json: - schema: *488 + schema: *490 examples: - default: &494 + default: &496 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -75514,8 +76066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -75538,7 +76090,7 @@ paths: description: Response content: application/json: - schema: *488 + schema: *490 examples: default: value: @@ -75589,8 +76141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '204': @@ -75612,8 +76164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -75640,7 +76192,7 @@ paths: application/json: schema: type: array - items: &489 + items: &491 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -75683,7 +76235,7 @@ paths: - content - created_at examples: - default: &563 + default: &565 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -75728,8 +76280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -75762,9 +76314,9 @@ paths: description: Reaction exists content: application/json: - schema: *489 + schema: *491 examples: - default: &490 + default: &492 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -75793,9 +76345,9 @@ paths: description: Reaction created content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '422': *15 x-github: githubCloudOnly: false @@ -75817,10 +76369,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *356 - - *357 + - *358 + - *359 - *104 - - &564 + - &566 name: reaction_id description: The unique identifier of the reaction. in: path @@ -75875,8 +76427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *356 - - *357 + - *358 + - *359 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -75932,9 +76484,9 @@ paths: application/json: schema: type: array - items: *491 + items: *493 examples: - default: &632 + default: &634 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -76028,9 +76580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *356 - - *357 - - &492 + - *358 + - *359 + - &494 name: commit_sha description: The SHA of the commit. in: path @@ -76102,9 +76654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *356 - - *357 - - *492 + - *358 + - *359 + - *494 - *17 - *19 responses: @@ -76114,9 +76666,9 @@ paths: application/json: schema: type: array - items: *488 + items: *490 examples: - default: *493 + default: *495 headers: Link: *70 x-github: @@ -76144,9 +76696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *356 - - *357 - - *492 + - *358 + - *359 + - *494 requestBody: required: true content: @@ -76181,9 +76733,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *490 examples: - default: *494 + default: *496 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76211,9 +76763,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *356 - - *357 - - *492 + - *358 + - *359 + - *494 - *17 - *19 responses: @@ -76223,9 +76775,9 @@ paths: application/json: schema: type: array - items: *495 + items: *497 examples: - default: &624 + default: &626 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -76762,11 +77314,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *356 - - *357 + - *358 + - *359 - *19 - *17 - - &496 + - &498 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -76781,9 +77333,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *493 examples: - default: &611 + default: &613 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -76871,7 +77423,7 @@ paths: schema: type: string examples: - default: &505 + default: &507 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -76884,7 +77436,7 @@ paths: schema: type: string examples: - default: &506 + default: &508 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -76937,11 +77489,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *356 - - *357 - - *496 - - *497 + - *358 + - *359 - *498 + - *499 + - *500 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -76975,9 +77527,9 @@ paths: type: integer check_runs: type: array - items: *433 + items: *435 examples: - default: *499 + default: *501 headers: Link: *70 x-github: @@ -77002,9 +77554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *356 - - *357 - - *496 + - *358 + - *359 + - *498 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -77012,7 +77564,7 @@ paths: schema: type: integer example: 1 - - *497 + - *499 - *17 - *19 responses: @@ -77030,7 +77582,7 @@ paths: type: integer check_suites: type: array - items: *438 + items: *440 examples: default: value: @@ -77230,9 +77782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *356 - - *357 - - *496 + - *358 + - *359 + - *498 - *17 - *19 responses: @@ -77430,9 +77982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *356 - - *357 - - *496 + - *358 + - *359 + - *498 - *17 - *19 responses: @@ -77442,7 +77994,7 @@ paths: application/json: schema: type: array - items: &705 + items: &720 title: Status description: The status of a commit. type: object @@ -77523,7 +78075,7 @@ paths: site_admin: false headers: Link: *70 - '301': *360 + '301': *362 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77551,8 +78103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -77581,20 +78133,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *500 - required: *501 + properties: *502 + required: *503 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &502 + properties: &504 url: type: string format: uri html_url: type: string format: uri - required: &503 + required: &505 - url - html_url nullable: true @@ -77608,26 +78160,26 @@ paths: contributing: title: Community Health File type: object - properties: *502 - required: *503 + properties: *504 + required: *505 nullable: true readme: title: Community Health File type: object - properties: *502 - required: *503 + properties: *504 + required: *505 nullable: true issue_template: title: Community Health File type: object - properties: *502 - required: *503 + properties: *504 + required: *505 nullable: true pull_request_template: title: Community Health File type: object - properties: *502 - required: *503 + properties: *504 + required: *505 nullable: true required: - code_of_conduct @@ -77754,8 +78306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *356 - - *357 + - *358 + - *359 - *19 - *17 - name: basehead @@ -77798,8 +78350,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *491 - merge_base_commit: *491 + base_commit: *493 + merge_base_commit: *493 status: type: string enum: @@ -77819,10 +78371,10 @@ paths: example: 6 commits: type: array - items: *491 + items: *493 files: type: array - items: *504 + items: *506 required: - url - html_url @@ -78068,12 +78620,12 @@ paths: schema: type: string examples: - default: *505 + default: *507 application/vnd.github.patch: schema: type: string examples: - default: *506 + default: *508 '404': *6 '500': *55 '503': *122 @@ -78118,8 +78670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *356 - - *357 + - *358 + - *359 - name: path description: path parameter in: path @@ -78279,7 +78831,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &507 + response-if-content-is-a-file-github-object: &509 summary: Response if content is a file value: type: file @@ -78411,7 +78963,7 @@ paths: - size - type - url - - &637 + - &639 title: Content File description: Content File type: object @@ -78612,7 +79164,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *507 + response-if-content-is-a-file: *509 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -78681,7 +79233,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *508 + '302': *510 '304': *37 x-github: githubCloudOnly: false @@ -78734,8 +79286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *356 - - *357 + - *358 + - *359 - name: path description: path parameter in: path @@ -78828,7 +79380,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &511 title: File Commit description: File Commit type: object @@ -78980,7 +79532,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: example-for-creating-a-file: value: @@ -79034,7 +79586,7 @@ paths: schema: oneOf: - *3 - - &539 + - &541 description: Repository rule violation was detected type: object properties: @@ -79055,7 +79607,7 @@ paths: items: type: object properties: - placeholder_id: &697 + placeholder_id: &712 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -79087,8 +79639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *356 - - *357 + - *358 + - *359 - name: path description: path parameter in: path @@ -79149,7 +79701,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *511 examples: default: value: @@ -79204,8 +79756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *356 - - *357 + - *358 + - *359 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -79334,8 +79886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-cloud-agent-management#get-copilot-cloud-agent-configuration-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -79467,8 +80019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *212 - *213 - *214 @@ -79481,7 +80033,7 @@ paths: schema: type: string - *217 - - *510 + - *512 - *218 - *219 - *220 @@ -79496,7 +80048,7 @@ paths: application/json: schema: type: array - items: &514 + items: &516 type: object description: A Dependabot alert. properties: @@ -79543,7 +80095,7 @@ paths: - direct - transitive - inconclusive - security_advisory: *511 + security_advisory: *513 security_vulnerability: *66 url: *191 html_url: *192 @@ -79574,8 +80126,8 @@ paths: nullable: true maxLength: 280 fixed_at: *193 - auto_dismissed_at: *512 - dismissal_request: *513 + auto_dismissed_at: *514 + dismissal_request: *515 assignees: type: array description: The users assigned to this alert. @@ -79830,9 +80382,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *356 - - *357 - - &515 + - *358 + - *359 + - &517 name: alert_number in: path description: |- @@ -79847,7 +80399,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *516 examples: default: value: @@ -79979,9 +80531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *356 - - *357 - - *515 + - *358 + - *359 + - *517 requestBody: required: true content: @@ -80054,7 +80606,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *516 examples: default: value: @@ -80184,8 +80736,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -80203,7 +80755,7 @@ paths: type: integer secrets: type: array - items: &518 + items: &520 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -80256,16 +80808,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *516 + schema: *518 examples: - default: *517 + default: *519 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80285,15 +80837,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '200': description: Response content: application/json: - schema: *518 + schema: *520 examples: default: value: @@ -80319,8 +80871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 requestBody: required: true @@ -80373,8 +80925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *356 - - *357 + - *358 + - *359 - *171 responses: '204': @@ -80397,8 +80949,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *356 - - *357 + - *358 + - *359 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -80561,8 +81113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -80800,8 +81352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: sbom_uuid in: path required: true @@ -80812,7 +81364,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *519 + Location: *521 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -80833,8 +81385,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '201': description: Response @@ -80872,8 +81424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -80948,7 +81500,7 @@ paths: - version - url additionalProperties: false - metadata: &520 + metadata: &522 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -80981,7 +81533,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *520 + metadata: *522 resolved: type: object description: A collection of resolved package dependencies. @@ -80994,7 +81546,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *520 + metadata: *522 relationship: type: string description: A notation of whether a dependency is requested @@ -81123,8 +81675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *356 - - *357 + - *358 + - *359 - name: sha description: The SHA recorded at creation time. in: query @@ -81164,9 +81716,9 @@ paths: application/json: schema: type: array - items: *521 + items: *523 examples: - default: *522 + default: *524 headers: Link: *70 x-github: @@ -81232,8 +81784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -81314,7 +81866,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *523 examples: simple-example: summary: Simple example @@ -81387,9 +81939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *356 - - *357 - - &523 + - *358 + - *359 + - &525 name: deployment_id description: deployment_id parameter in: path @@ -81401,7 +81953,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *523 examples: default: value: @@ -81466,9 +82018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *356 - - *357 - - *523 + - *358 + - *359 + - *525 responses: '204': description: Response @@ -81490,9 +82042,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *356 - - *357 - - *523 + - *358 + - *359 + - *525 - *17 - *19 responses: @@ -81502,7 +82054,7 @@ paths: application/json: schema: type: array - items: &524 + items: &526 title: Deployment Status description: The status of a deployment. type: object @@ -81663,9 +82215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *356 - - *357 - - *523 + - *358 + - *359 + - *525 requestBody: required: true content: @@ -81740,9 +82292,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *526 examples: - default: &525 + default: &527 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -81798,9 +82350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *356 - - *357 - - *523 + - *358 + - *359 + - *525 - name: status_id in: path required: true @@ -81811,9 +82363,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *526 examples: - default: *525 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -81838,8 +82390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -81896,8 +82448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -81914,7 +82466,7 @@ paths: type: integer environments: type: array - items: &527 + items: &529 title: Environment description: Details of a deployment environment type: object @@ -81966,7 +82518,7 @@ paths: type: type: string example: wait_timer - wait_timer: &529 + wait_timer: &531 type: integer example: 30 description: The amount of time to delay a job after @@ -82003,7 +82555,7 @@ paths: items: type: object properties: - type: *526 + type: *528 reviewer: anyOf: - *4 @@ -82027,7 +82579,7 @@ paths: - id - node_id - type - deployment_branch_policy: &530 + deployment_branch_policy: &532 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -82143,9 +82695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *356 - - *357 - - &528 + - *358 + - *359 + - &530 name: environment_name in: path required: true @@ -82158,9 +82710,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *529 examples: - default: &531 + default: &533 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -82244,9 +82796,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 requestBody: required: false content: @@ -82255,7 +82807,7 @@ paths: type: object nullable: true properties: - wait_timer: *529 + wait_timer: *531 prevent_self_review: type: boolean example: false @@ -82272,13 +82824,13 @@ paths: items: type: object properties: - type: *526 + type: *528 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *530 + deployment_branch_policy: *532 additionalProperties: false examples: default: @@ -82298,9 +82850,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *529 examples: - default: *531 + default: *533 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -82324,9 +82876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 responses: '204': description: Default response @@ -82351,9 +82903,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *17 - *19 responses: @@ -82371,7 +82923,7 @@ paths: example: 2 branch_policies: type: array - items: &532 + items: &534 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -82428,9 +82980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 requestBody: required: true content: @@ -82476,9 +83028,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *534 examples: - example-wildcard: &533 + example-wildcard: &535 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -82520,10 +83072,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *356 - - *357 - - *528 - - &534 + - *358 + - *359 + - *530 + - &536 name: branch_policy_id in: path required: true @@ -82535,9 +83087,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *534 examples: - default: *533 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82556,10 +83108,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *356 - - *357 - - *528 - - *534 + - *358 + - *359 + - *530 + - *536 requestBody: required: true content: @@ -82587,9 +83139,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *534 examples: - default: *533 + default: *535 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82608,10 +83160,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *356 - - *357 - - *528 - - *534 + - *358 + - *359 + - *530 + - *536 responses: '204': description: Response @@ -82636,9 +83188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *528 - - *357 - - *356 + - *530 + - *359 + - *358 responses: '200': description: List of deployment protection rules @@ -82654,7 +83206,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &535 + items: &537 title: Deployment protection rule description: Deployment protection rule type: object @@ -82673,7 +83225,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &536 + app: &538 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -82772,9 +83324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *528 - - *357 - - *356 + - *530 + - *359 + - *358 requestBody: content: application/json: @@ -82795,9 +83347,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *535 + schema: *537 examples: - default: &537 + default: &539 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -82832,9 +83384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *528 - - *357 - - *356 + - *530 + - *359 + - *358 - *19 - *17 responses: @@ -82853,7 +83405,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *536 + items: *538 examples: default: value: @@ -82888,10 +83440,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *356 - - *357 - - *528 - - &538 + - *358 + - *359 + - *530 + - &540 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -82903,9 +83455,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *537 examples: - default: *537 + default: *539 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82926,10 +83478,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *528 - - *357 - - *356 - - *538 + - *530 + - *359 + - *358 + - *540 responses: '204': description: Response @@ -82955,9 +83507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *17 - *19 responses: @@ -82975,9 +83527,9 @@ paths: type: integer secrets: type: array - items: *400 + items: *402 examples: - default: *401 + default: *403 headers: Link: *70 x-github: @@ -83002,9 +83554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 responses: '200': description: Response @@ -83034,18 +83586,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *171 responses: '200': description: Response content: application/json: - schema: *400 + schema: *402 examples: - default: *414 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83067,9 +83619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *171 requestBody: required: true @@ -83127,9 +83679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *171 responses: '204': @@ -83155,9 +83707,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *180 - *19 responses: @@ -83175,9 +83727,9 @@ paths: type: integer variables: type: array - items: *402 + items: *404 examples: - default: *403 + default: *405 headers: Link: *70 x-github: @@ -83200,9 +83752,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 requestBody: required: true content: @@ -83254,18 +83806,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *356 - - *357 - - *528 + - *358 + - *359 + - *530 - *174 responses: '200': description: Response content: application/json: - schema: *402 + schema: *404 examples: - default: *415 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83286,10 +83838,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 - - *528 + - *530 requestBody: required: true content: @@ -83331,10 +83883,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *356 - - *357 + - *358 + - *359 - *174 - - *528 + - *530 responses: '204': description: Response @@ -83356,8 +83908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -83425,8 +83977,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *356 - - *357 + - *358 + - *359 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -83585,8 +84137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -83618,9 +84170,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *361 examples: - default: *361 + default: *363 '400': *14 '422': *15 '403': *29 @@ -83641,8 +84193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -83702,7 +84254,7 @@ paths: schema: oneOf: - *132 - - *539 + - *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83727,8 +84279,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *356 - - *357 + - *358 + - *359 - name: file_sha in: path required: true @@ -83827,8 +84379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -83937,7 +84489,7 @@ paths: description: Response content: application/json: - schema: &540 + schema: &542 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -84151,15 +84703,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *356 - - *357 - - *492 + - *358 + - *359 + - *494 responses: '200': description: Response content: application/json: - schema: *540 + schema: *542 examples: default: value: @@ -84215,9 +84767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *356 - - *357 - - &541 + - *358 + - *359 + - &543 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -84234,7 +84786,7 @@ paths: application/json: schema: type: array - items: &542 + items: &544 title: Git Reference description: Git references within a repository type: object @@ -84309,17 +84861,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *356 - - *357 - - *541 + - *358 + - *359 + - *543 responses: '200': description: Response content: application/json: - schema: *542 + schema: *544 examples: - default: &543 + default: &545 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -84348,8 +84900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -84378,9 +84930,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *544 examples: - default: *543 + default: *545 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -84406,9 +84958,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *356 - - *357 - - *541 + - *358 + - *359 + - *543 requestBody: required: true content: @@ -84437,9 +84989,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *544 examples: - default: *543 + default: *545 '422': *15 '409': *54 x-github: @@ -84457,9 +85009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *356 - - *357 - - *541 + - *358 + - *359 + - *543 responses: '204': description: Response @@ -84514,8 +85066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -84582,7 +85134,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &547 title: Git Tag description: Metadata for a Git tag type: object @@ -84633,7 +85185,7 @@ paths: - sha - type - url - verification: *544 + verification: *546 required: - sha - url @@ -84643,7 +85195,7 @@ paths: - tag - message examples: - default: &546 + default: &548 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -84716,8 +85268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *356 - - *357 + - *358 + - *359 - name: tag_sha in: path required: true @@ -84728,9 +85280,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *547 examples: - default: *546 + default: *548 '404': *6 '409': *54 x-github: @@ -84754,8 +85306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -84828,7 +85380,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &549 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -84924,8 +85476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *356 - - *357 + - *358 + - *359 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -84948,7 +85500,7 @@ paths: description: Response content: application/json: - schema: *547 + schema: *549 examples: default-response: summary: Default response @@ -85006,8 +85558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-the-hash-algorithm-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -85050,8 +85602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -85061,7 +85613,7 @@ paths: application/json: schema: type: array - items: &548 + items: &550 title: Webhook description: Webhooks for repositories. type: object @@ -85115,7 +85667,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &822 + last_response: &837 title: Hook Response type: object properties: @@ -85189,8 +85741,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -85242,9 +85794,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: &549 + default: &551 value: type: Repository id: 12345678 @@ -85292,17 +85844,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 responses: '200': description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *549 + default: *551 '404': *6 x-github: githubCloudOnly: false @@ -85322,8 +85874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 requestBody: required: true @@ -85369,9 +85921,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *550 examples: - default: *549 + default: *551 '422': *15 '404': *6 x-github: @@ -85392,8 +85944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 responses: '204': @@ -85418,8 +85970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *231 responses: '200': @@ -85447,8 +85999,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *231 requestBody: required: false @@ -85493,8 +86045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 - *17 - *232 @@ -85527,8 +86079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 - *16 responses: @@ -85557,8 +86109,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 - *16 responses: @@ -85582,8 +86134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 responses: '204': @@ -85609,8 +86161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *356 - - *357 + - *358 + - *359 - *231 responses: '204': @@ -85634,8 +86186,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response if immutable releases are enabled @@ -85681,8 +86233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': *61 '409': *54 @@ -85702,8 +86254,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': *61 '409': *54 @@ -85760,14 +86312,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: &550 + schema: &552 title: Import description: A repository import from an external source. type: object @@ -85866,7 +86418,7 @@ paths: - html_url - authors_url examples: - default: &553 + default: &555 value: vcs: subversion use_lfs: true @@ -85882,7 +86434,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &551 + '503': &553 description: Unavailable due to service under maintenance. content: application/json: @@ -85911,8 +86463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -85960,7 +86512,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *552 examples: default: value: @@ -85985,7 +86537,7 @@ paths: type: string '422': *15 '404': *6 - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86013,8 +86565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -86063,7 +86615,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *552 examples: example-1: summary: Example 1 @@ -86111,7 +86663,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86134,12 +86686,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86165,9 +86717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *356 - - *357 - - &750 + - *358 + - *359 + - &765 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -86181,7 +86733,7 @@ paths: application/json: schema: type: array - items: &552 + items: &554 title: Porter Author description: Porter Author type: object @@ -86235,7 +86787,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86260,8 +86812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *356 - - *357 + - *358 + - *359 - name: author_id in: path required: true @@ -86291,7 +86843,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *554 examples: default: value: @@ -86304,7 +86856,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86328,8 +86880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -86370,7 +86922,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86398,8 +86950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -86426,11 +86978,11 @@ paths: description: Response content: application/json: - schema: *550 + schema: *552 examples: - default: *553 + default: *555 '422': *15 - '503': *551 + '503': *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86453,8 +87005,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -86462,8 +87014,8 @@ paths: application/json: schema: *22 examples: - default: *554 - '301': *360 + default: *556 + '301': *362 '404': *6 x-github: githubCloudOnly: false @@ -86483,8 +87035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -86497,7 +87049,7 @@ paths: properties: {} additionalProperties: false examples: - default: &556 + default: &558 value: limit: collaborators_only origin: repository @@ -86522,13 +87074,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *555 + schema: *557 examples: default: summary: Example request body @@ -86542,7 +87094,7 @@ paths: application/json: schema: *250 examples: - default: *556 + default: *558 '409': description: Response x-github: @@ -86564,8 +87116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -86592,8 +87144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -86647,13 +87199,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#add-users-to-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: &557 + schema: &559 title: Interaction Limits Pull Request Bypass List description: A list of user logins to add or remove from the pull request creation cap bypass list. @@ -86703,13 +87255,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: application/json: - schema: *557 + schema: *559 examples: default: summary: Example request body @@ -86742,8 +87294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -86796,8 +87348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -86873,8 +87425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -86884,9 +87436,9 @@ paths: application/json: schema: type: array - items: *558 + items: *560 examples: - default: &743 + default: &758 value: - id: 1 repository: @@ -87017,8 +87569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *356 - - *357 + - *358 + - *359 - *254 requestBody: required: false @@ -87048,7 +87600,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *560 examples: default: value: @@ -87179,8 +87731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *356 - - *357 + - *358 + - *359 - *254 responses: '204': @@ -87204,8 +87756,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/issue-types#list-issue-types-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -87215,7 +87767,7 @@ paths: type: array items: *258 examples: - default: *559 + default: *561 '404': *6 x-github: githubCloudOnly: false @@ -87244,8 +87796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *356 - - *357 + - *358 + - *359 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -87332,7 +87884,7 @@ paths: type: array items: *88 examples: - default: &575 + default: &577 value: - id: 1 node_id: MDU6SXNzdWUx @@ -87481,7 +88033,7 @@ paths: state_reason: completed headers: Link: *70 - '301': *360 + '301': *362 '422': *15 '404': *6 x-github: @@ -87510,8 +88062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -87620,7 +88172,7 @@ paths: application/json: schema: *88 examples: - default: &572 + default: &574 value: id: 1 node_id: MDU6SXNzdWUx @@ -87783,7 +88335,7 @@ paths: '422': *15 '503': *122 '404': *6 - '410': *560 + '410': *562 x-github: triggersNotification: true githubCloudOnly: false @@ -87821,8 +88373,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *112 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -87843,9 +88395,9 @@ paths: application/json: schema: type: array - items: *561 + items: *563 examples: - default: &574 + default: &576 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87904,17 +88456,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '200': description: Response content: application/json: - schema: *561 + schema: *563 examples: - default: &562 + default: &564 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -87970,8 +88522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -87994,9 +88546,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *563 examples: - default: *562 + default: *564 '422': *15 x-github: githubCloudOnly: false @@ -88014,8 +88566,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '204': @@ -88044,15 +88596,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '200': description: Response content: application/json: - schema: *561 + schema: *563 examples: default: value: @@ -88108,7 +88660,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *560 + '410': *562 '422': *15 x-github: githubCloudOnly: false @@ -88125,8 +88677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '204': @@ -88134,7 +88686,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *560 + '410': *562 '503': *122 x-github: githubCloudOnly: false @@ -88152,8 +88704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -88180,9 +88732,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *563 + default: *565 headers: Link: *70 '404': *6 @@ -88203,8 +88755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -88237,16 +88789,16 @@ paths: description: Reaction exists content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '201': description: Reaction created content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '422': *15 x-github: githubCloudOnly: false @@ -88268,10 +88820,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *356 - - *357 + - *358 + - *359 - *104 - - *564 + - *566 responses: '204': description: Response @@ -88291,8 +88843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -88302,7 +88854,7 @@ paths: application/json: schema: type: array - items: &571 + items: &573 title: Issue Event description: Issue Event type: object @@ -88345,9 +88897,9 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *565 - required: *566 - x-github-breaking-changes: *567 + properties: *567 + required: *568 + x-github-breaking-changes: *569 nullable: true label: title: Issue Event Label @@ -88456,7 +89008,7 @@ paths: required: - from - to - issue_type: &568 + issue_type: &570 title: Issue Type description: The type of issue. type: object @@ -88484,14 +89036,14 @@ paths: required: - id - name - prev_issue_type: *568 + prev_issue_type: *570 sub_issue: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: &569 + properties: &571 number: type: integer description: The number of the referenced issue. @@ -88529,7 +89081,7 @@ paths: - id - node_id - name - required: &570 + required: &572 - number - title - state @@ -88541,24 +89093,24 @@ paths: event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 blocked_by: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 blocking: title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 author_association: *85 lock_reason: type: string @@ -88758,8 +89310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *356 - - *357 + - *358 + - *359 - name: event_id in: path required: true @@ -88770,7 +89322,7 @@ paths: description: Response content: application/json: - schema: *571 + schema: *573 examples: default: value: @@ -88963,7 +89515,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *560 + '410': *562 '403': *29 x-github: githubCloudOnly: false @@ -88997,9 +89549,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *356 - - *357 - - &573 + - *358 + - *359 + - &575 name: issue_number description: The number that identifies the issue. in: path @@ -89015,7 +89567,7 @@ paths: examples: default: summary: Issue - value: *572 + value: *574 pinned_comment: summary: Issue with pinned comment value: @@ -89220,9 +89772,9 @@ paths: - op: remove path: "/value/assignee" version: '2026-03-10' - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 '304': *37 x-github: githubCloudOnly: false @@ -89247,9 +89799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: false content: @@ -89394,13 +89946,13 @@ paths: - type: object properties: {} examples: - default: *572 + default: *574 '422': *15 '503': *122 '403': *29 - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89428,9 +89980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: false content: @@ -89458,7 +90010,7 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89474,9 +90026,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: content: application/json: @@ -89503,7 +90055,7 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89525,9 +90077,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - name: assignee in: path required: true @@ -89567,9 +90119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *95 - *17 - *19 @@ -89580,13 +90132,13 @@ paths: application/json: schema: type: array - items: *561 + items: *563 examples: - default: *574 + default: *576 headers: Link: *70 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89615,9 +90167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -89639,16 +90191,16 @@ paths: description: Response content: application/json: - schema: *561 + schema: *563 examples: - default: *562 + default: *564 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *560 + '410': *562 '422': *15 '404': *6 x-github: @@ -89676,9 +90228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -89690,12 +90242,12 @@ paths: type: array items: *88 examples: - default: *575 + default: *577 headers: Link: *70 - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89723,9 +90275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -89749,15 +90301,15 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *360 + '301': *362 '403': *29 - '410': *560 + '410': *562 '422': *15 '404': *6 x-github: @@ -89788,9 +90340,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -89804,13 +90356,13 @@ paths: application/json: schema: *88 examples: - default: *572 - '301': *360 + default: *574 + '301': *362 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *560 + '410': *562 x-github: triggersNotification: true githubCloudOnly: false @@ -89836,9 +90388,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -89850,12 +90402,12 @@ paths: type: array items: *88 examples: - default: *575 + default: *577 headers: Link: *70 - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89872,9 +90424,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -89888,7 +90440,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &579 + - &581 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -89942,7 +90494,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &580 + - &582 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -90078,7 +90630,7 @@ paths: - performed_via_github_app - assignee - assigner - - &581 + - &583 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -90129,7 +90681,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &582 + - &584 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -90180,7 +90732,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &583 + - &585 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -90234,7 +90786,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &584 + - &586 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -90281,7 +90833,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &585 + - &587 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -90328,7 +90880,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &586 + - &588 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -90388,7 +90940,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &587 + - &589 title: Locked Issue Event description: Locked Issue Event type: object @@ -90436,7 +90988,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &588 + - &590 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -90502,7 +91054,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &589 + - &591 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -90568,7 +91120,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &590 + - &592 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -90634,7 +91186,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &591 + - &593 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -90690,7 +91242,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &596 + - &598 title: Issue Type Added Issue Event description: Issue Type Added Issue Event type: object @@ -90723,7 +91275,7 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *568 + issue_type: *570 required: - issue_type - id @@ -90735,7 +91287,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &597 + - &599 title: Issue Type Removed Issue Event description: Issue Type Removed Issue Event type: object @@ -90768,7 +91320,7 @@ paths: nullable: true properties: *83 required: *84 - prev_issue_type: *568 + prev_issue_type: *570 required: - prev_issue_type - id @@ -90780,7 +91332,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &598 + - &600 title: Issue Type Changed Issue Event description: Issue Type Changed Issue Event type: object @@ -90813,8 +91365,8 @@ paths: nullable: true properties: *83 required: *84 - issue_type: *568 - prev_issue_type: *568 + issue_type: *570 + prev_issue_type: *570 required: - issue_type - prev_issue_type @@ -90827,7 +91379,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &599 + - &601 title: Sub-issue Added Issue Event description: Sub-issue Added Issue Event type: object @@ -90867,8 +91419,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - sub_issue - id @@ -90880,7 +91432,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &600 + - &602 title: Sub-issue Removed Issue Event description: Sub-issue Removed Issue Event type: object @@ -90920,8 +91472,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - sub_issue - id @@ -90933,7 +91485,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &601 + - &603 title: Parent-issue Added Issue Event description: Parent-issue Added Issue Event type: object @@ -90973,8 +91525,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - parent_issue - id @@ -90986,7 +91538,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &602 + - &604 title: Parent-issue Removed Issue Event description: Parent-issue Removed Issue Event type: object @@ -91026,8 +91578,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - parent_issue - id @@ -91039,7 +91591,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &603 + - &605 title: Blocked-by Added Issue Event description: Blocked-by Added Issue Event type: object @@ -91079,8 +91631,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - blocked_by - id @@ -91092,7 +91644,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &604 + - &606 title: Blocked-by Removed Issue Event description: Blocked-by Removed Issue Event type: object @@ -91132,8 +91684,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - blocked_by - id @@ -91145,7 +91697,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &605 + - &607 title: Blocking Added Issue Event description: Blocking Added Issue Event type: object @@ -91185,8 +91737,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - blocking - id @@ -91198,7 +91750,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &606 + - &608 title: Blocking Removed Issue Event description: Blocking Removed Issue Event type: object @@ -91238,8 +91790,8 @@ paths: events). type: object nullable: true - properties: *569 - required: *570 + properties: *571 + required: *572 required: - blocking - id @@ -91286,7 +91838,7 @@ paths: color: red headers: Link: *70 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91303,9 +91855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -91315,9 +91867,9 @@ paths: application/json: schema: type: array - items: *576 + items: *578 examples: - default: &577 + default: &579 value: - issue_field_id: 1 issue_field_name: DRI @@ -91357,9 +91909,9 @@ paths: color: green headers: Link: *70 - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91388,9 +91940,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -91460,9 +92012,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *576 + items: *578 examples: - default: *577 + default: *579 '400': *14 '403': *29 '404': *6 @@ -91498,9 +92050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -91565,9 +92117,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *576 + items: *578 examples: - default: *577 + default: *579 '400': *14 '403': *29 '404': *6 @@ -91598,9 +92150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *257 responses: '204': @@ -91626,9 +92178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -91640,7 +92192,7 @@ paths: type: array items: *87 examples: - default: &578 + default: &580 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91658,9 +92210,9 @@ paths: default: false headers: Link: *70 - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91676,9 +92228,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: false content: @@ -91723,10 +92275,10 @@ paths: type: array items: *87 examples: - default: *578 - '301': *360 + default: *580 + '301': *362 '404': *6 - '410': *560 + '410': *562 '422': *15 x-github: githubCloudOnly: false @@ -91743,9 +92295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: false content: @@ -91807,10 +92359,10 @@ paths: type: array items: *87 examples: - default: *578 - '301': *360 + default: *580 + '301': *362 '404': *6 - '410': *560 + '410': *562 '422': *15 x-github: githubCloudOnly: false @@ -91827,15 +92379,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 responses: '204': description: Response - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91854,9 +92406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - name: name in: path required: true @@ -91880,9 +92432,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *360 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91902,9 +92454,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: false content: @@ -91932,7 +92484,7 @@ paths: '204': description: Response '403': *29 - '410': *560 + '410': *562 '404': *6 '422': *15 x-github: @@ -91950,9 +92502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 responses: '204': description: Response @@ -91982,9 +92534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 responses: '200': description: Response @@ -91992,10 +92544,10 @@ paths: application/json: schema: *88 examples: - default: *572 - '301': *360 + default: *574 + '301': *362 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92012,9 +92564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -92040,13 +92592,13 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *563 + default: *565 headers: Link: *70 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92064,9 +92616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -92098,16 +92650,16 @@ paths: description: Response content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '201': description: Response content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '422': *15 x-github: githubCloudOnly: false @@ -92129,10 +92681,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *356 - - *357 - - *573 - - *564 + - *358 + - *359 + - *575 + - *566 responses: '204': description: Response @@ -92161,9 +92713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -92187,7 +92739,7 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92220,9 +92772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -92234,11 +92786,11 @@ paths: type: array items: *88 examples: - default: *575 + default: *577 headers: Link: *70 '404': *6 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92266,9 +92818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -92297,14 +92849,14 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *560 + '410': *562 '422': *15 '404': *6 x-github: @@ -92324,9 +92876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 requestBody: required: true content: @@ -92359,7 +92911,7 @@ paths: application/json: schema: *88 examples: - default: *572 + default: *574 '403': *29 '404': *6 '422': *7 @@ -92381,9 +92933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *356 - - *357 - - *573 + - *358 + - *359 + - *575 - *17 - *19 responses: @@ -92398,8 +92950,6 @@ paths: description: Timeline Event type: object anyOf: - - *579 - - *580 - *581 - *582 - *583 @@ -92411,6 +92961,8 @@ paths: - *589 - *590 - *591 + - *592 + - *593 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92471,15 +93023,15 @@ paths: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *592 - required: *593 + properties: *594 + required: *595 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *594 - required: *595 + properties: *596 + required: *597 nullable: true required: - event @@ -92734,7 +93286,7 @@ paths: type: string comments: type: array - items: &626 + items: &628 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -92949,7 +93501,7 @@ paths: type: string comments: type: array - items: *488 + items: *490 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93083,8 +93635,6 @@ paths: - commit_url - created_at - performed_via_github_app - - *596 - - *597 - *598 - *599 - *600 @@ -93094,6 +93644,8 @@ paths: - *604 - *605 - *606 + - *607 + - *608 examples: default: value: @@ -93250,7 +93802,7 @@ paths: Link: *70 '404': *6 '400': *14 - '410': *560 + '410': *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93267,8 +93819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -93278,7 +93830,7 @@ paths: application/json: schema: type: array - items: &607 + items: &609 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93344,8 +93896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -93381,9 +93933,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: &608 + default: &610 value: id: 1 key: ssh-rsa AAA... @@ -93417,9 +93969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *356 - - *357 - - &609 + - *358 + - *359 + - &611 name: key_id description: The unique identifier of the key. in: path @@ -93431,9 +93983,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *608 + default: *610 '404': *6 x-github: githubCloudOnly: false @@ -93451,9 +94003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *356 - - *357 - - *609 + - *358 + - *359 + - *611 responses: '204': description: Response @@ -93473,8 +94025,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -93486,7 +94038,7 @@ paths: type: array items: *87 examples: - default: *578 + default: *580 headers: Link: *70 '404': *6 @@ -93507,8 +94059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -93546,7 +94098,7 @@ paths: application/json: schema: *87 examples: - default: &610 + default: &612 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93578,8 +94130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *356 - - *357 + - *358 + - *359 - name: name in: path required: true @@ -93592,7 +94144,7 @@ paths: application/json: schema: *87 examples: - default: *610 + default: *612 '404': *6 x-github: githubCloudOnly: false @@ -93609,8 +94161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *356 - - *357 + - *358 + - *359 - name: name in: path required: true @@ -93675,8 +94227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *356 - - *357 + - *358 + - *359 - name: name in: path required: true @@ -93702,8 +94254,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -93742,9 +94294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *356 - - *357 - - *461 + - *358 + - *359 + - *463 responses: '200': description: Response @@ -93889,8 +94441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -93955,8 +94507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -93990,9 +94542,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *491 + schema: *493 examples: - default: *611 + default: *613 '204': description: Response when already merged '404': @@ -94017,8 +94569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *356 - - *357 + - *358 + - *359 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94059,7 +94611,7 @@ paths: application/json: schema: type: array - items: &612 + items: &614 title: Milestone description: A collection of related issues and pull requests. type: object @@ -94120,8 +94672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -94161,9 +94713,9 @@ paths: description: Response content: application/json: - schema: *612 + schema: *614 examples: - default: &613 + default: &615 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94222,9 +94774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *356 - - *357 - - &614 + - *358 + - *359 + - &616 name: milestone_number description: The number that identifies the milestone. in: path @@ -94236,9 +94788,9 @@ paths: description: Response content: application/json: - schema: *612 + schema: *614 examples: - default: *613 + default: *615 '404': *6 x-github: githubCloudOnly: false @@ -94255,9 +94807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *356 - - *357 - - *614 + - *358 + - *359 + - *616 requestBody: required: false content: @@ -94295,9 +94847,9 @@ paths: description: Response content: application/json: - schema: *612 + schema: *614 examples: - default: *613 + default: *615 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94313,9 +94865,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *356 - - *357 - - *614 + - *358 + - *359 + - *616 responses: '204': description: Response @@ -94336,9 +94888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *356 - - *357 - - *614 + - *358 + - *359 + - *616 - *17 - *19 responses: @@ -94350,7 +94902,7 @@ paths: type: array items: *87 examples: - default: *578 + default: *580 headers: Link: *70 x-github: @@ -94369,12 +94921,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *356 - - *357 - - *615 - - *616 - - *95 + - *358 + - *359 - *617 + - *618 + - *95 + - *619 - *17 - *19 responses: @@ -94386,7 +94938,7 @@ paths: type: array items: *115 examples: - default: *618 + default: *620 headers: Link: *70 x-github: @@ -94410,8 +94962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -94469,14 +95021,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: &619 + schema: &621 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94601,7 +95153,7 @@ paths: - custom_404 - public examples: - default: &620 + default: &622 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94642,8 +95194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -94697,9 +95249,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - default: *620 + default: *622 '422': *15 '409': *54 x-github: @@ -94722,8 +95274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -94822,8 +95374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -94849,8 +95401,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -94860,7 +95412,7 @@ paths: application/json: schema: type: array - items: &621 + items: &623 title: Page Build description: Page Build type: object @@ -94954,8 +95506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *356 - - *357 + - *358 + - *359 responses: '201': description: Response @@ -95000,16 +95552,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *621 + schema: *623 examples: - default: &622 + default: &624 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95057,8 +95609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *356 - - *357 + - *358 + - *359 - name: build_id in: path required: true @@ -95069,9 +95621,9 @@ paths: description: Response content: application/json: - schema: *621 + schema: *623 examples: - default: *622 + default: *624 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95091,8 +95643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -95197,9 +95749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *356 - - *357 - - &623 + - *358 + - *359 + - &625 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95257,9 +95809,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *356 - - *357 - - *623 + - *358 + - *359 + - *625 responses: '204': *61 '404': *6 @@ -95286,8 +95838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -95545,8 +96097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Private vulnerability reporting status @@ -95583,8 +96135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': *61 '422': *14 @@ -95605,8 +96157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': *61 '422': *14 @@ -95628,8 +96180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -95668,8 +96220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -95731,8 +96283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *356 - - *357 + - *358 + - *359 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -95792,9 +96344,9 @@ paths: application/json: schema: type: array - items: *495 + items: *497 examples: - default: *624 + default: *626 headers: Link: *70 '304': *37 @@ -95826,8 +96378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -95892,7 +96444,7 @@ paths: description: Response content: application/json: - schema: &628 + schema: &630 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96047,7 +96599,7 @@ paths: items: *4 requested_teams: type: array - items: *348 + items: *350 head: type: object properties: @@ -96103,7 +96655,7 @@ paths: - review_comment - self author_association: *85 - auto_merge: *625 + auto_merge: *627 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96289,7 +96841,7 @@ paths: - review_comments version: '2026-03-10' examples: - default: &629 + default: &631 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96827,8 +97379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *356 - - *357 + - *358 + - *359 - name: sort in: query required: false @@ -96857,9 +97409,9 @@ paths: application/json: schema: type: array - items: *626 + items: *628 examples: - default: &631 + default: &633 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -96936,17 +97488,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '200': description: Response content: application/json: - schema: *626 + schema: *628 examples: - default: &627 + default: &629 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97021,8 +97573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -97045,9 +97597,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *628 examples: - default: *627 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97063,8 +97615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *356 - - *357 + - *358 + - *359 - *104 responses: '204': @@ -97086,8 +97638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -97114,9 +97666,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *563 + default: *565 headers: Link: *70 '404': *6 @@ -97137,8 +97689,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *356 - - *357 + - *358 + - *359 - *104 requestBody: required: true @@ -97171,16 +97723,16 @@ paths: description: Reaction exists content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '201': description: Reaction created content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '422': *15 x-github: githubCloudOnly: false @@ -97202,10 +97754,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *356 - - *357 + - *358 + - *359 - *104 - - *564 + - *566 responses: '204': description: Response @@ -97248,9 +97800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *356 - - *357 - - &630 + - *358 + - *359 + - &632 name: pull_number description: The number that identifies the pull request. in: path @@ -97263,9 +97815,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *628 + schema: *630 examples: - default: *629 + default: *631 '304': *37 '404': *6 '406': @@ -97300,9 +97852,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: false content: @@ -97344,9 +97896,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *630 examples: - default: *629 + default: *631 '422': *15 '403': *29 x-github: @@ -97368,9 +97920,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: true content: @@ -97432,7 +97984,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -97440,7 +97992,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '401': *25 '403': *29 '404': *6 @@ -97470,9 +98022,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 - *112 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -97493,9 +98045,9 @@ paths: application/json: schema: type: array - items: *626 + items: *628 examples: - default: *631 + default: *633 headers: Link: *70 x-github: @@ -97528,9 +98080,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: true content: @@ -97635,7 +98187,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *628 examples: example-for-a-multi-line-comment: value: @@ -97723,9 +98275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 - *104 requestBody: required: true @@ -97748,7 +98300,7 @@ paths: description: Response content: application/json: - schema: *626 + schema: *628 examples: default: value: @@ -97834,9 +98386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 - *17 - *19 responses: @@ -97846,9 +98398,9 @@ paths: application/json: schema: type: array - items: *491 + items: *493 examples: - default: *632 + default: *634 headers: Link: *70 x-github: @@ -97878,9 +98430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 - *17 - *19 responses: @@ -97890,7 +98442,7 @@ paths: application/json: schema: type: array - items: *504 + items: *506 examples: default: value: @@ -97928,9 +98480,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 responses: '204': description: Response if pull request has been merged @@ -97953,9 +98505,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: false content: @@ -98066,9 +98618,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 responses: '200': description: Response @@ -98143,9 +98695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: false content: @@ -98182,7 +98734,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *497 examples: default: value: @@ -98718,9 +99270,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: true content: @@ -98754,7 +99306,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *497 examples: default: value: @@ -99270,9 +99822,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 - *17 - *19 responses: @@ -99282,7 +99834,7 @@ paths: application/json: schema: type: array - items: &633 + items: &635 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99433,9 +99985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: false content: @@ -99521,9 +100073,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *635 examples: - default: &635 + default: &637 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99586,10 +100138,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 - - &634 + - *358 + - *359 + - *632 + - &636 name: review_id description: The unique identifier of the review. in: path @@ -99601,9 +100153,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *635 examples: - default: &636 + default: &638 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99662,10 +100214,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 - - *634 + - *358 + - *359 + - *632 + - *636 requestBody: required: true content: @@ -99688,7 +100240,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *635 examples: default: value: @@ -99750,18 +100302,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 - - *634 + - *358 + - *359 + - *632 + - *636 responses: '200': description: Response content: application/json: - schema: *633 + schema: *635 examples: - default: *635 + default: *637 '422': *7 '404': *6 x-github: @@ -99788,10 +100340,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *356 - - *357 - - *630 - - *634 + - *358 + - *359 + - *632 + - *636 - *17 - *19 responses: @@ -100026,10 +100578,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 - - *634 + - *358 + - *359 + - *632 + - *636 requestBody: required: true content: @@ -100057,7 +100609,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *635 examples: default: value: @@ -100120,10 +100672,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *356 - - *357 - - *630 - - *634 + - *358 + - *359 + - *632 + - *636 requestBody: required: true content: @@ -100158,9 +100710,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *635 examples: - default: *636 + default: *638 '404': *6 '422': *7 '403': *29 @@ -100182,9 +100734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *356 - - *357 - - *630 + - *358 + - *359 + - *632 requestBody: required: false content: @@ -100247,8 +100799,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *356 - - *357 + - *358 + - *359 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100261,9 +100813,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: &638 + default: &640 value: type: file encoding: base64 @@ -100305,8 +100857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *356 - - *357 + - *358 + - *359 - name: dir description: The alternate path to look for a README file in: path @@ -100326,9 +100878,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *638 + default: *640 '404': *6 '422': *15 x-github: @@ -100350,8 +100902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -100361,7 +100913,7 @@ paths: application/json: schema: type: array - items: *639 + items: *641 examples: default: value: @@ -100455,8 +101007,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -100532,9 +101084,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: &643 + default: &645 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100639,9 +101191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *356 - - *357 - - &641 + - *358 + - *359 + - &643 name: asset_id description: The unique identifier of the asset. in: path @@ -100653,9 +101205,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *642 examples: - default: &642 + default: &644 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -100690,7 +101242,7 @@ paths: type: User site_admin: false '404': *6 - '302': *508 + '302': *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100706,9 +101258,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *356 - - *357 - - *641 + - *358 + - *359 + - *643 requestBody: required: false content: @@ -100736,9 +101288,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *642 examples: - default: *642 + default: *644 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100754,9 +101306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *356 - - *357 - - *641 + - *358 + - *359 + - *643 responses: '204': description: Response @@ -100781,8 +101333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -100867,16 +101419,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *643 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -100894,8 +101446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *356 - - *357 + - *358 + - *359 - name: tag description: tag parameter in: path @@ -100908,9 +101460,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *643 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -100932,9 +101484,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *356 - - *357 - - &644 + - *358 + - *359 + - &646 name: release_id description: The unique identifier of the release. in: path @@ -100948,9 +101500,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *639 + schema: *641 examples: - default: *643 + default: *645 '401': description: Unauthorized x-github: @@ -100968,9 +101520,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 requestBody: required: false content: @@ -101034,9 +101586,9 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *643 + default: *645 '404': description: Not Found if the discussion category name is invalid content: @@ -101057,9 +101609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 responses: '204': description: Response @@ -101080,9 +101632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 - *17 - *19 responses: @@ -101092,7 +101644,7 @@ paths: application/json: schema: type: array - items: *640 + items: *642 examples: default: value: @@ -101173,9 +101725,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 - name: name in: query required: true @@ -101201,7 +101753,7 @@ paths: description: Response for successful upload content: application/json: - schema: *640 + schema: *642 examples: response-for-successful-upload: value: @@ -101256,9 +101808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -101282,9 +101834,9 @@ paths: application/json: schema: type: array - items: *489 + items: *491 examples: - default: *563 + default: *565 headers: Link: *70 '404': *6 @@ -101305,9 +101857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *356 - - *357 - - *644 + - *358 + - *359 + - *646 requestBody: required: true content: @@ -101337,16 +101889,16 @@ paths: description: Reaction exists content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '201': description: Reaction created content: application/json: - schema: *489 + schema: *491 examples: - default: *490 + default: *492 '422': *15 x-github: githubCloudOnly: false @@ -101368,10 +101920,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *356 - - *357 - - *644 - - *564 + - *358 + - *359 + - *646 + - *566 responses: '204': description: Response @@ -101395,9 +101947,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *356 - - *357 - - *422 + - *358 + - *359 + - *424 - *17 - *19 responses: @@ -101414,7 +101966,7 @@ paths: oneOf: - allOf: - *320 - - &645 + - &647 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101435,70 +101987,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *321 - - *645 + - *647 - allOf: - *322 - - *645 + - *647 - allOf: - *323 - - *645 + - *647 - allOf: - - *646 - - *645 + - *648 + - *647 - allOf: - *324 - - *645 + - *647 - allOf: - *325 - - *645 + - *647 - allOf: - *326 - - *645 + - *647 - allOf: - *327 - - *645 + - *647 - allOf: - *328 - - *645 + - *647 - allOf: - *329 - - *645 + - *647 - allOf: - *330 - - *645 + - *647 - allOf: - *331 - - *645 + - *647 - allOf: - *332 - - *645 + - *647 - allOf: - *333 - - *645 + - *647 - allOf: - *338 - - *645 + - *647 - allOf: - *339 - - *645 + - *647 - allOf: - *340 - - *645 + - *647 - allOf: + - *649 - *647 - - *645 - allOf: - *334 - - *645 + - *647 - allOf: - *335 - - *645 + - *647 - allOf: - *336 - - *645 + - *647 - allOf: - *337 - - *645 + - *647 examples: default: value: @@ -101537,8 +102089,8 @@ paths: category: repos subcategory: rules parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 - name: includes_parents @@ -101549,7 +102101,7 @@ paths: schema: type: boolean default: true - - *648 + - *650 responses: '200': description: Response @@ -101604,8 +102156,8 @@ paths: category: repos subcategory: rules parameters: - - *356 - - *357 + - *358 + - *359 requestBody: description: Request body required: true @@ -101634,7 +102186,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *649 + items: *651 required: - name - enforcement @@ -101667,7 +102219,7 @@ paths: application/json: schema: *341 examples: - default: &660 + default: &662 value: id: 42 name: super cool ruleset @@ -101715,13 +102267,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *356 - - *357 - - *650 - - *651 + - *358 + - *359 - *652 - *653 - *654 + - *655 + - *656 - *17 - *19 responses: @@ -101729,9 +102281,9 @@ paths: description: Response content: application/json: - schema: *655 + schema: *657 examples: - default: *656 + default: *658 '404': *6 '500': *55 x-github: @@ -101752,17 +102304,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *356 - - *357 - - *657 + - *358 + - *359 + - *659 responses: '200': description: Response content: application/json: - schema: *658 + schema: *660 examples: - default: *659 + default: *661 '404': *6 '500': *55 x-github: @@ -101790,8 +102342,8 @@ paths: category: repos subcategory: rules parameters: - - *356 - - *357 + - *358 + - *359 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101813,7 +102365,7 @@ paths: application/json: schema: *341 examples: - default: *660 + default: *662 '404': *6 '500': *55 put: @@ -101831,8 +102383,8 @@ paths: category: repos subcategory: rules parameters: - - *356 - - *357 + - *358 + - *359 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101866,7 +102418,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *649 + items: *651 examples: default: value: @@ -101896,7 +102448,7 @@ paths: application/json: schema: *341 examples: - default: *660 + default: *662 '404': *6 '422': *15 '500': *55 @@ -101915,8 +102467,8 @@ paths: category: repos subcategory: rules parameters: - - *356 - - *357 + - *358 + - *359 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101939,8 +102491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 - name: ruleset_id @@ -101958,7 +102510,7 @@ paths: type: array items: *344 examples: - default: *661 + default: *663 '404': *6 '500': *55 x-github: @@ -101977,8 +102529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *356 - - *357 + - *358 + - *359 - name: ruleset_id description: The ID of the ruleset. in: path @@ -101996,7 +102548,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: default: value: @@ -102051,21 +102603,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *356 - - *357 - - *663 - - *664 + - *358 + - *359 - *665 - *666 - *667 - *668 - *669 - *670 + - *671 + - *672 - *62 - *19 - *17 - - *671 - - *672 - *673 - *674 - *675 @@ -102073,6 +102623,8 @@ paths: - *677 - *678 - *679 + - *680 + - *681 responses: '200': description: Response @@ -102099,8 +102651,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *680 - resolution: *681 + state: *682 + resolution: *683 resolved_at: type: string format: date-time @@ -102206,7 +102758,7 @@ paths: pull request. ' - oneOf: *682 + oneOf: *684 nullable: true has_more_locations: type: boolean @@ -102370,16 +102922,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *356 - - *357 - - *455 - - *676 + - *358 + - *359 + - *457 + - *678 responses: '200': description: Response content: application/json: - schema: &683 + schema: &685 type: object properties: number: *188 @@ -102397,8 +102949,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *680 - resolution: *681 + state: *682 + resolution: *683 resolved_at: type: string format: date-time @@ -102504,7 +103056,7 @@ paths: pull request. ' - oneOf: *682 + oneOf: *684 nullable: true has_more_locations: type: boolean @@ -102532,7 +103084,7 @@ paths: properties: *20 required: *21 nullable: true - metadata: &843 + metadata: &858 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -102605,9 +103157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 requestBody: required: true content: @@ -102615,8 +103167,8 @@ paths: schema: type: object properties: - state: *680 - resolution: *681 + state: *682 + resolution: *683 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -102660,7 +103212,7 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: default: value: @@ -102762,9 +103314,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *356 - - *357 - - *455 + - *358 + - *359 + - *457 - *19 - *17 responses: @@ -102775,7 +103327,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &845 + items: &860 type: object properties: type: @@ -102801,8 +103353,6 @@ paths: example: commit details: oneOf: - - *684 - - *685 - *686 - *687 - *688 @@ -102814,6 +103364,8 @@ paths: - *694 - *695 - *696 + - *697 + - *698 examples: default: value: @@ -102883,6 +103435,221 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/custom-patterns": + get: + summary: List repository custom patterns + description: |- + Lists secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *358 + - *359 + - *699 + - *700 + - *701 + - *62 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *345 + examples: + default: *702 + headers: + Link: *70 + '403': *29 + '404': *6 + post: + summary: Bulk create repository custom patterns + description: |- + Bulk creates secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-create-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *358 + - *359 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: *703 + examples: + default: *704 + responses: + '201': + description: All patterns created successfully. + content: + application/json: + schema: + type: object + properties: + created_patterns: + type: array + description: The list of successfully created custom patterns. + items: *345 + examples: + default: *705 + '400': *14 + '403': *29 + '404': *6 + '422': + description: Validation failed for one or more patterns. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A summary message describing the error. + validation_errors: + type: object + description: A map of validation errors keyed by the zero-based + index of the pattern that failed. + additionalProperties: + type: object + properties: + errors: + type: array + description: List of validation errors for this pattern. + items: *706 + delete: + summary: Bulk delete repository custom patterns + description: |- + Bulk deletes secret scanning custom patterns for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/bulk-delete-repo-custom-patterns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *358 + - *359 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to delete. + maxItems: 500 + items: *707 + post_delete_action: + type: string + description: |- + What to do with alerts associated with the deleted patterns. + `delete_alerts` permanently removes the alerts. + `resolve_alerts` resolves the alerts as "pattern deleted". + Defaults to `delete_alerts` when not specified. + enum: + - delete_alerts + - resolve_alerts + default: delete_alerts + examples: + default: *708 + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *29 + '404': *6 + '412': *347 + "/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}": + patch: + summary: Update a repository custom pattern + description: |- + Updates a secret scanning custom pattern for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/update-repo-custom-pattern + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: custom-patterns + parameters: + - *358 + - *359 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: *709 + examples: + default: *710 + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *345 + examples: + default: *711 + '400': *14 + '403': *29 + '404': *6 + '412': *347 + '422': *15 "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -102899,8 +103666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -102908,14 +103675,14 @@ paths: schema: type: object properties: - reason: &698 + reason: &713 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *697 + placeholder_id: *712 required: - reason - placeholder_id @@ -102932,7 +103699,7 @@ paths: schema: type: object properties: - reason: *698 + reason: *713 expire_at: type: string format: date-time @@ -102978,8 +103745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -102994,7 +103761,7 @@ paths: properties: incremental_scans: type: array - items: &699 + items: &714 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103025,15 +103792,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *699 + items: *714 backfill_scans: type: array - items: *699 + items: *714 custom_pattern_backfill_scans: type: array items: allOf: - - *699 + - *714 - type: object properties: pattern_name: @@ -103046,7 +103813,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *699 + items: *714 examples: default: value: @@ -103111,8 +103878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *356 - - *357 + - *358 + - *359 - *62 - name: sort description: The property to sort the results by. @@ -103156,9 +103923,9 @@ paths: application/json: schema: type: array - items: *700 + items: *715 examples: - default: *701 + default: *716 '400': *14 '404': *6 x-github: @@ -103181,8 +103948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -103255,7 +104022,7 @@ paths: login: type: string description: The username of the user credited. - type: *347 + type: *349 required: - login - type @@ -103342,9 +104109,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *715 examples: - default: &703 + default: &718 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103583,8 +104350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -103688,7 +104455,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *715 examples: default: value: @@ -103841,17 +104608,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *356 - - *357 - - *702 + - *358 + - *359 + - *717 responses: '200': description: Response content: application/json: - schema: *700 + schema: *715 examples: - default: *703 + default: *718 '403': *29 '404': *6 x-github: @@ -103875,9 +104642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *356 - - *357 - - *702 + - *358 + - *359 + - *717 requestBody: required: true content: @@ -103950,7 +104717,7 @@ paths: login: type: string description: The username of the user credited. - type: *347 + type: *349 required: - login - type @@ -104036,10 +104803,10 @@ paths: description: Response content: application/json: - schema: *700 + schema: *715 examples: - default: *703 - add_credit: *703 + default: *718 + add_credit: *718 '403': *29 '404': *6 '422': @@ -104077,9 +104844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *356 - - *357 - - *702 + - *358 + - *359 + - *717 responses: '202': *39 '400': *14 @@ -104106,17 +104873,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *356 - - *357 - - *702 + - *358 + - *359 + - *717 responses: '202': description: Response content: application/json: - schema: *359 + schema: *361 examples: - default: *361 + default: *363 '400': *14 '422': *15 '403': *29 @@ -104142,8 +104909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -104242,8 +105009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104252,7 +105019,7 @@ paths: application/json: schema: type: array - items: &704 + items: &719 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104285,8 +105052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -104362,8 +105129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -104459,8 +105226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104614,8 +105381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104625,7 +105392,7 @@ paths: application/json: schema: type: array - items: *704 + items: *719 examples: default: value: @@ -104658,8 +105425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *356 - - *357 + - *358 + - *359 - name: sha in: path required: true @@ -104713,7 +105480,7 @@ paths: description: Response content: application/json: - schema: *705 + schema: *720 examples: default: value: @@ -104767,8 +105534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -104800,14 +105567,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &706 + schema: &721 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104875,8 +105642,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: false content: @@ -104902,7 +105669,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *721 examples: default: value: @@ -104929,8 +105696,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -104950,8 +105717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -105030,8 +105797,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *356 - - *357 + - *358 + - *359 - name: ref in: path required: true @@ -105067,8 +105834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *356 - - *357 + - *358 + - *359 - *17 - *19 responses: @@ -105100,8 +105867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *356 - - *357 + - *358 + - *359 - *19 - *17 responses: @@ -105109,7 +105876,7 @@ paths: description: Response content: application/json: - schema: &707 + schema: &722 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105121,7 +105888,7 @@ paths: required: - names examples: - default: &708 + default: &723 value: names: - octocat @@ -105144,8 +105911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -105176,9 +105943,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *722 examples: - default: *708 + default: *723 '404': *6 '422': *7 x-github: @@ -105199,9 +105966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *356 - - *357 - - &709 + - *358 + - *359 + - &724 name: per description: The time frame to display results for. in: query @@ -105230,7 +105997,7 @@ paths: example: 128 clones: type: array - items: &710 + items: &725 title: Traffic type: object properties: @@ -105317,8 +106084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -105408,8 +106175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *356 - - *357 + - *358 + - *359 responses: '200': description: Response @@ -105469,9 +106236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *356 - - *357 - - *709 + - *358 + - *359 + - *724 responses: '200': description: Response @@ -105490,7 +106257,7 @@ paths: example: 3782 views: type: array - items: *710 + items: *725 required: - uniques - count @@ -105567,8 +106334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *356 - - *357 + - *358 + - *359 requestBody: required: true content: @@ -105848,8 +106615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -105872,8 +106639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -105895,8 +106662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -105922,8 +106689,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *356 - - *357 + - *358 + - *359 - name: ref in: path required: true @@ -106015,9 +106782,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *361 examples: - default: *361 + default: *363 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106268,7 +107035,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &711 + text_matches: &726 title: Search Result Text Matches type: array items: @@ -106430,7 +107197,7 @@ paths: enum: - author-date - committer-date - - &712 + - &727 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -106501,7 +107268,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *420 + properties: *422 nullable: true comment_count: type: integer @@ -106521,7 +107288,7 @@ paths: url: type: string format: uri - verification: *544 + verification: *546 required: - author - committer @@ -106540,7 +107307,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *420 + properties: *422 nullable: true parents: type: array @@ -106558,7 +107325,7 @@ paths: type: number node_id: type: string - text_matches: *711 + text_matches: *726 required: - sha - node_id @@ -106750,7 +107517,7 @@ paths: - interactions - created - updated - - *712 + - *727 - *17 - *19 - name: advanced_search @@ -106864,11 +107631,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: type: string state_reason: @@ -106900,7 +107667,7 @@ paths: type: string format: date-time nullable: true - text_matches: *711 + text_matches: *726 pull_request: type: object properties: @@ -107216,7 +107983,7 @@ paths: enum: - created - updated - - *712 + - *727 - *17 - *19 responses: @@ -107260,7 +108027,7 @@ paths: nullable: true score: type: number - text_matches: *711 + text_matches: *726 required: - id - node_id @@ -107345,7 +108112,7 @@ paths: - forks - help-wanted-issues - updated - - *712 + - *727 - *17 - *19 responses: @@ -107593,7 +108360,7 @@ paths: - admin - pull - push - text_matches: *711 + text_matches: *726 temp_clone_token: type: string allow_merge_commit: @@ -107893,7 +108660,7 @@ paths: type: string format: uri nullable: true - text_matches: *711 + text_matches: *726 related: type: array nullable: true @@ -108084,7 +108851,7 @@ paths: - followers - repositories - joined - - *712 + - *727 - *17 - *19 responses: @@ -108188,7 +108955,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *711 + text_matches: *726 blog: type: string nullable: true @@ -108267,7 +109034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &715 + - &730 name: team_id description: The unique identifier of the team. in: path @@ -108279,9 +109046,9 @@ paths: description: Response content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '404': *6 x-github: githubCloudOnly: false @@ -108308,7 +109075,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *715 + - *730 requestBody: required: true content: @@ -108371,16 +109138,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '201': description: Response content: application/json: - schema: *352 + schema: *354 examples: - default: *353 + default: *355 '404': *6 '422': *15 '403': *29 @@ -108408,7 +109175,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *715 + - *730 responses: '204': description: Response @@ -108437,7 +109204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *715 + - *730 - *17 - *19 responses: @@ -108477,7 +109244,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *715 + - *730 - name: role description: Filters members returned by their role in the team. in: query @@ -108498,9 +109265,9 @@ paths: application/json: schema: type: array - items: *716 + items: *731 examples: - default: *717 + default: *732 headers: Link: *70 '404': *6 @@ -108528,7 +109295,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *715 + - *730 - *74 responses: '204': @@ -108565,7 +109332,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *715 + - *730 - *74 responses: '204': @@ -108605,7 +109372,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *715 + - *730 - *74 responses: '204': @@ -108642,16 +109409,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *715 + - *730 - *74 responses: '200': description: Response content: application/json: - schema: *355 + schema: *357 examples: - response-if-user-is-a-team-maintainer: *718 + response-if-user-is-a-team-maintainer: *733 '404': *6 x-github: githubCloudOnly: false @@ -108684,7 +109451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *715 + - *730 - *74 requestBody: required: false @@ -108710,9 +109477,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *357 examples: - response-if-users-membership-with-team-is-now-pending: *719 + response-if-users-membership-with-team-is-now-pending: *734 '403': description: Forbidden if team synchronization is set up '422': @@ -108746,7 +109513,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *715 + - *730 - *74 responses: '204': @@ -108774,7 +109541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *715 + - *730 - *17 - *19 responses: @@ -108816,15 +109583,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *715 - - *356 - - *357 + - *730 + - *358 + - *359 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *720 + schema: *735 examples: alternative-response-with-extra-repository-information: value: @@ -108981,9 +109748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *715 - - *356 - - *357 + - *730 + - *358 + - *359 requestBody: required: false content: @@ -109033,9 +109800,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *715 - - *356 - - *357 + - *730 + - *358 + - *359 responses: '204': description: Response @@ -109060,7 +109827,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *715 + - *730 - *17 - *19 responses: @@ -109072,7 +109839,7 @@ paths: type: array items: *210 examples: - response-if-child-teams-exist: *721 + response-if-child-teams-exist: *736 headers: Link: *70 '404': *6 @@ -109105,7 +109872,7 @@ paths: application/json: schema: oneOf: - - &723 + - &738 title: Private User description: Private User type: object @@ -109308,7 +110075,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *722 + - *737 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -109461,7 +110228,7 @@ paths: description: Response content: application/json: - schema: *723 + schema: *738 examples: default: value: @@ -109807,7 +110574,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -109815,7 +110582,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '401': *25 '403': *29 '404': *6 @@ -109859,7 +110626,7 @@ paths: type: integer secrets: type: array - items: &724 + items: &739 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -109899,7 +110666,7 @@ paths: - visibility - selected_repositories_url examples: - default: *481 + default: *483 headers: Link: *70 x-github: @@ -109975,7 +110742,7 @@ paths: description: Response content: application/json: - schema: *724 + schema: *739 examples: default: value: @@ -110273,7 +111040,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '304': *37 '500': *55 '401': *25 @@ -110331,7 +111098,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '401': *25 '403': *29 '404': *6 @@ -110388,7 +111155,7 @@ paths: description: Response content: application/json: - schema: &725 + schema: &740 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -110429,7 +111196,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &726 + default: &741 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -110474,9 +111241,9 @@ paths: description: Response content: application/json: - schema: *725 + schema: *740 examples: - default: *726 + default: *741 '404': *6 x-github: githubCloudOnly: false @@ -110513,9 +111280,9 @@ paths: type: integer machines: type: array - items: *727 + items: *742 examples: - default: *728 + default: *743 '304': *37 '500': *55 '401': *25 @@ -110594,13 +111361,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *359 + repository: *361 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *479 - required: *480 + properties: *481 + required: *482 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -111382,7 +112149,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '304': *37 '500': *55 '400': *14 @@ -111422,7 +112189,7 @@ paths: application/json: schema: *263 examples: - default: *478 + default: *480 '500': *55 '401': *25 '403': *29 @@ -111454,7 +112221,7 @@ paths: type: array items: *276 examples: - default: &740 + default: &755 value: - id: 197 name: hello_docker @@ -111555,7 +112322,7 @@ paths: application/json: schema: type: array - items: &729 + items: &744 title: Email description: Email type: object @@ -111620,9 +112387,9 @@ paths: application/json: schema: type: array - items: *729 + items: *744 examples: - default: &742 + default: &757 value: - email: octocat@github.com verified: true @@ -111697,7 +112464,7 @@ paths: application/json: schema: type: array - items: *729 + items: *744 examples: default: value: @@ -111953,7 +112720,7 @@ paths: application/json: schema: type: array - items: &730 + items: &745 title: GPG Key description: A unique encryption key type: object @@ -112084,7 +112851,7 @@ paths: - subkeys - revoked examples: - default: &759 + default: &774 value: - id: 3 name: Octocat's GPG Key @@ -112169,9 +112936,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *745 examples: - default: &731 + default: &746 value: id: 3 name: Octocat's GPG Key @@ -112228,7 +112995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &732 + - &747 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -112240,9 +113007,9 @@ paths: description: Response content: application/json: - schema: *730 + schema: *745 examples: - default: *731 + default: *746 '404': *6 '304': *37 '403': *29 @@ -112265,7 +113032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *732 + - *747 responses: '204': description: Response @@ -112582,7 +113349,7 @@ paths: required: true content: application/json: - schema: *555 + schema: *557 examples: default: value: @@ -112732,7 +113499,7 @@ paths: application/json: schema: type: array - items: &733 + items: &748 title: Key description: Key type: object @@ -112833,9 +113600,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *748 examples: - default: &734 + default: &749 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -112868,15 +113635,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *609 + - *611 responses: '200': description: Response content: application/json: - schema: *733 + schema: *748 examples: - default: *734 + default: *749 '404': *6 '304': *37 '403': *29 @@ -112899,7 +113666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *609 + - *611 responses: '204': description: Response @@ -112932,7 +113699,7 @@ paths: application/json: schema: type: array - items: &735 + items: &750 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -113000,7 +113767,7 @@ paths: - account - plan examples: - default: &736 + default: &751 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -113062,9 +113829,9 @@ paths: application/json: schema: type: array - items: *735 + items: *750 examples: - default: *736 + default: *751 headers: Link: *70 '304': *37 @@ -113307,7 +114074,7 @@ paths: application/json: schema: *267 examples: - default: &737 + default: &752 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -113356,7 +114123,7 @@ paths: application/json: schema: *267 examples: - default: *737 + default: *752 '403': *29 '404': *6 '422': *15 @@ -114081,7 +114848,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *270 - - *738 + - *753 responses: '204': description: Response @@ -114214,7 +114981,7 @@ paths: - docker - nuget - container - - *739 + - *754 - *19 - *17 responses: @@ -114226,8 +114993,8 @@ paths: type: array items: *276 examples: - default: *740 - '400': *741 + default: *755 + '400': *756 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114256,7 +115023,7 @@ paths: application/json: schema: *276 examples: - default: &760 + default: &775 value: id: 40201 name: octo-name @@ -114618,9 +115385,9 @@ paths: application/json: schema: type: array - items: *729 + items: *744 examples: - default: *742 + default: *757 headers: Link: *70 '304': *37 @@ -114733,7 +115500,7 @@ paths: type: array items: *82 examples: - default: &749 + default: &764 summary: Default response value: - id: 1296269 @@ -115037,9 +115804,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *361 examples: - default: *361 + default: *363 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -115083,9 +115850,9 @@ paths: application/json: schema: type: array - items: *558 + items: *560 examples: - default: *743 + default: *758 headers: Link: *70 '304': *37 @@ -115170,7 +115937,7 @@ paths: application/json: schema: type: array - items: &744 + items: &759 title: Social account description: Social media account type: object @@ -115185,7 +115952,7 @@ paths: - provider - url examples: - default: &745 + default: &760 value: - provider: twitter url: https://twitter.com/github @@ -115247,9 +116014,9 @@ paths: application/json: schema: type: array - items: *744 + items: *759 examples: - default: *745 + default: *760 '422': *15 '304': *37 '404': *6 @@ -115336,7 +116103,7 @@ paths: application/json: schema: type: array - items: &746 + items: &761 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -115356,7 +116123,7 @@ paths: - title - created_at examples: - default: &777 + default: &792 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -115420,9 +116187,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *761 examples: - default: &747 + default: &762 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -115452,7 +116219,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &748 + - &763 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -115464,9 +116231,9 @@ paths: description: Response content: application/json: - schema: *746 + schema: *761 examples: - default: *747 + default: *762 '404': *6 '304': *37 '403': *29 @@ -115489,7 +116256,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *748 + - *763 responses: '204': description: Response @@ -115518,7 +116285,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &778 + - &793 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -115543,11 +116310,11 @@ paths: type: array items: *82 examples: - default-response: *749 + default-response: *764 application/vnd.github.v3.star+json: schema: type: array - items: &779 + items: &794 title: Starred Repository description: Starred Repository type: object @@ -115703,8 +116470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response if this repository is starred by you @@ -115732,8 +116499,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -115757,8 +116524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *356 - - *357 + - *358 + - *359 responses: '204': description: Response @@ -115830,7 +116597,7 @@ paths: application/json: schema: type: array - items: *352 + items: *354 examples: default: value: @@ -115916,10 +116683,10 @@ paths: application/json: schema: oneOf: - - *723 - - *722 + - *738 + - *737 examples: - default-response: &753 + default-response: &768 summary: Default response value: login: octocat @@ -115954,7 +116721,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &754 + response-with-git-hub-plan-information: &769 summary: Response with GitHub plan information value: login: octocat @@ -116011,7 +116778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &751 + - &766 name: user_id description: The unique identifier of the user. in: path @@ -116077,7 +116844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *750 + - *765 - *17 responses: '200': @@ -116112,7 +116879,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *751 + - *766 - *294 requestBody: required: true @@ -116184,7 +116951,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *752 + schema: *767 examples: table_view: summary: Response for creating a table view @@ -116236,11 +117003,11 @@ paths: application/json: schema: oneOf: - - *723 - - *722 + - *738 + - *737 examples: - default-response: *753 - response-with-git-hub-plan-information: *754 + default-response: *768 + response-with-git-hub-plan-information: *769 '404': *6 x-github: githubCloudOnly: false @@ -116290,8 +117057,8 @@ paths: required: - subject_digests examples: - default: *755 - withPredicateType: *756 + default: *770 + withPredicateType: *771 responses: '200': description: Response @@ -116344,7 +117111,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *757 + default: *772 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -116564,7 +117331,7 @@ paths: initiator: type: string examples: - default: *416 + default: *418 '201': description: Response content: @@ -116859,7 +117626,7 @@ paths: application/json: schema: *204 examples: - default: &758 + default: &773 summary: Example response for a user copilot space value: id: 42 @@ -116960,7 +117727,7 @@ paths: application/json: schema: *204 examples: - default: *758 + default: *773 '403': *29 '404': *6 x-github: @@ -117083,7 +117850,7 @@ paths: application/json: schema: *204 examples: - default: *758 + default: *773 '403': *29 '404': *6 '422': *15 @@ -117851,7 +118618,7 @@ paths: type: array items: *276 examples: - default: *740 + default: *755 '403': *29 '401': *25 x-github: @@ -118235,9 +119002,9 @@ paths: application/json: schema: type: array - items: *730 + items: *745 examples: - default: *759 + default: *774 headers: Link: *70 x-github: @@ -118341,7 +119108,7 @@ paths: application/json: schema: *22 examples: - default: *554 + default: *556 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118465,7 +119232,7 @@ paths: - docker - nuget - container - - *739 + - *754 - *74 - *19 - *17 @@ -118478,10 +119245,10 @@ paths: type: array items: *276 examples: - default: *740 + default: *755 '403': *29 '401': *25 - '400': *741 + '400': *756 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118511,7 +119278,7 @@ paths: application/json: schema: *276 examples: - default: *760 + default: *775 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -118860,7 +119627,7 @@ paths: type: array items: *298 examples: - default: *761 + default: *776 headers: Link: *70 '304': *37 @@ -118920,7 +119687,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *762 + items: *777 required: - name - data_type @@ -118936,7 +119703,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *763 + iteration_configuration: *778 required: - name - data_type @@ -118958,8 +119725,8 @@ paths: value: name: Due date data_type: date - single_select_field: *764 - iteration_field: *765 + single_select_field: *779 + iteration_field: *780 responses: '201': description: Response @@ -118967,11 +119734,11 @@ paths: application/json: schema: *298 examples: - text_field: *766 - number_field: *767 - date_field: *768 - single_select_field: *769 - iteration_field: *770 + text_field: *781 + number_field: *782 + date_field: *783 + single_select_field: *784 + iteration_field: *785 '304': *37 '403': *29 '401': *25 @@ -118993,7 +119760,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *294 - - *771 + - *786 - *74 responses: '200': @@ -119002,7 +119769,7 @@ paths: application/json: schema: *298 examples: - default: *772 + default: *787 headers: Link: *70 '304': *37 @@ -119356,7 +120123,7 @@ paths: parameters: - *294 - *74 - - *773 + - *788 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -119895,7 +120662,7 @@ paths: parameters: - *74 - *124 - - *774 + - *789 - *126 responses: '200': @@ -119994,9 +120761,9 @@ paths: - *124 - *125 - *126 - - *775 + - *790 - *129 - - *776 + - *791 responses: '200': description: Response when getting a billing usage summary @@ -120130,9 +120897,9 @@ paths: application/json: schema: type: array - items: *744 + items: *759 examples: - default: *745 + default: *760 headers: Link: *70 x-github: @@ -120162,9 +120929,9 @@ paths: application/json: schema: type: array - items: *746 + items: *761 examples: - default: *777 + default: *792 headers: Link: *70 x-github: @@ -120189,7 +120956,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *74 - - *778 + - *793 - *62 - *17 - *19 @@ -120201,11 +120968,11 @@ paths: schema: anyOf: - type: array - items: *779 + items: *794 - type: array items: *82 examples: - default-response: *749 + default-response: *764 headers: Link: *70 x-github: @@ -120364,7 +121131,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &780 + enterprise: &795 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -120422,7 +121189,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &781 + installation: &796 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -120441,7 +121208,7 @@ x-webhooks: required: - id - node_id - organization: &782 + organization: &797 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -120501,13 +121268,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &783 + repository: &798 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &815 + properties: &830 id: description: Unique identifier of the repository example: 42 @@ -121202,7 +121969,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &816 + required: &831 - archive_url - assignees_url - blobs_url @@ -121276,7 +122043,7 @@ x-webhooks: - watchers_count - created_at - updated_at - x-github-breaking-changes: &817 + x-github-breaking-changes: &832 - changeset: remove_use_squash_pr_title_as_default patch: properties: @@ -121367,10 +122134,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -121446,11 +122213,11 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - rule: &784 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + rule: &799 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -121673,11 +122440,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - rule: *784 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + rule: *799 sender: *4 required: - action @@ -121860,11 +122627,11 @@ x-webhooks: - everyone required: - from - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - rule: *784 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + rule: *799 sender: *4 required: - action @@ -121948,7 +122715,7 @@ x-webhooks: type: string enum: - completed - check_run: &786 + check_run: &801 title: CheckRun description: A check performed on the code of a given code change type: object @@ -122039,7 +122806,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *785 + deployment: *800 details_url: example: https://example.com type: string @@ -122124,10 +122891,10 @@ x-webhooks: - output - app - pull_requests - installation: *781 - enterprise: *780 - organization: *782 - repository: *783 + installation: *796 + enterprise: *795 + organization: *797 + repository: *798 sender: *4 required: - check_run @@ -122518,11 +123285,11 @@ x-webhooks: type: string enum: - created - check_run: *786 - installation: *781 - enterprise: *780 - organization: *782 - repository: *783 + check_run: *801 + installation: *796 + enterprise: *795 + organization: *797 + repository: *798 sender: *4 required: - check_run @@ -122916,11 +123683,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *786 - installation: *781 - enterprise: *780 - organization: *782 - repository: *783 + check_run: *801 + installation: *796 + enterprise: *795 + organization: *797 + repository: *798 requested_action: description: The action requested by the user. type: object @@ -123323,11 +124090,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *786 - installation: *781 - enterprise: *780 - organization: *782 - repository: *783 + check_run: *801 + installation: *796 + enterprise: *795 + organization: *797 + repository: *798 sender: *4 required: - check_run @@ -124297,10 +125064,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -124999,10 +125766,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -125695,10 +126462,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -125864,7 +126631,7 @@ x-webhooks: required: - login - id - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126009,20 +126776,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &787 + commit_oid: &802 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *780 - installation: *781 - organization: *782 - ref: &788 + enterprise: *795 + installation: *796 + organization: *797 + ref: &803 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *783 + repository: *798 sender: *4 required: - action @@ -126187,7 +126954,7 @@ x-webhooks: required: - login - id - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -126417,12 +127184,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *787 - enterprise: *780 - installation: *781 - organization: *782 - ref: *788 - repository: *783 + commit_oid: *802 + enterprise: *795 + installation: *796 + organization: *797 + ref: *803 + repository: *798 sender: *4 required: - action @@ -126517,7 +127284,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -126688,12 +127455,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *787 - enterprise: *780 - installation: *781 - organization: *782 - ref: *788 - repository: *783 + commit_oid: *802 + enterprise: *795 + installation: *796 + organization: *797 + ref: *803 + repository: *798 sender: *4 required: - action @@ -126859,7 +127626,7 @@ x-webhooks: required: - login - id - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127025,12 +127792,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *787 - enterprise: *780 - installation: *781 - organization: *782 - ref: *788 - repository: *783 + commit_oid: *802 + enterprise: *795 + installation: *796 + organization: *797 + ref: *803 + repository: *798 sender: *4 required: - action @@ -127129,7 +127896,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127304,16 +128071,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *783 + repository: *798 sender: *4 required: - action @@ -127410,7 +128177,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -127550,12 +128317,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *787 - enterprise: *780 - installation: *781 - organization: *782 - ref: *788 - repository: *783 + commit_oid: *802 + enterprise: *795 + installation: *796 + organization: *797 + ref: *803 + repository: *798 sender: *4 required: - action @@ -127721,7 +128488,7 @@ x-webhooks: required: - login - id - dismissed_comment: *450 + dismissed_comment: *452 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127866,10 +128633,10 @@ x-webhooks: - dismissed_reason - rule - tool - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -128124,10 +128891,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -128207,18 +128974,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *782 - pusher_type: &789 + organization: *797 + pusher_type: &804 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &790 + ref: &805 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -128228,7 +128995,7 @@ x-webhooks: enum: - tag - branch - repository: *783 + repository: *798 sender: *4 required: - ref @@ -128311,9 +129078,9 @@ x-webhooks: enum: - created definition: *306 - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 sender: *4 required: - action @@ -128398,9 +129165,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 sender: *4 required: - action @@ -128478,9 +129245,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *306 - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 sender: *4 required: - action @@ -128558,9 +129325,9 @@ x-webhooks: enum: - updated definition: *306 - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 sender: *4 required: - action @@ -128637,10 +129404,10 @@ x-webhooks: type: string enum: - updated - enterprise: *780 - installation: *781 - repository: *783 - organization: *782 + enterprise: *795 + installation: *796 + repository: *798 + organization: *797 sender: *4 new_property_values: type: array @@ -128725,18 +129492,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *780 - installation: *781 - organization: *782 - pusher_type: *789 - ref: *790 + enterprise: *795 + installation: *796 + organization: *797 + pusher_type: *804 + ref: *805 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *783 + repository: *798 sender: *4 required: - ref @@ -128816,11 +129583,11 @@ x-webhooks: type: string enum: - assignees_changed - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -128900,11 +129667,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -128985,11 +129752,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129070,11 +129837,11 @@ x-webhooks: type: string enum: - created - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129153,11 +129920,11 @@ x-webhooks: type: string enum: - dismissed - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129236,11 +130003,11 @@ x-webhooks: type: string enum: - fixed - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129320,11 +130087,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129403,11 +130170,11 @@ x-webhooks: type: string enum: - reopened - alert: *514 - installation: *781 - organization: *782 - enterprise: *780 - repository: *783 + alert: *516 + installation: *796 + organization: *797 + enterprise: *795 + repository: *798 sender: *4 required: - action @@ -129484,9 +130251,9 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - key: &791 + enterprise: *795 + installation: *796 + key: &806 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -129522,8 +130289,8 @@ x-webhooks: - verified - created_at - read_only - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -129600,11 +130367,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - key: *791 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + key: *806 + organization: *797 + repository: *798 sender: *4 required: - action @@ -130160,12 +130927,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - workflow: &797 + workflow: &812 title: Workflow type: object nullable: true @@ -130906,15 +131673,15 @@ x-webhooks: description: A request for a specific ref(branch,sha,tag) to be deployed type: object - properties: *792 - required: *793 + properties: *807 + required: *808 nullable: true pull_requests: type: array - items: *628 - repository: *783 - organization: *782 - installation: *781 + items: *630 + repository: *798 + organization: *797 + installation: *796 sender: *4 responses: '200': @@ -130985,7 +131752,7 @@ x-webhooks: type: string enum: - approved - approver: &794 + approver: &809 type: object properties: avatar_url: @@ -131028,11 +131795,11 @@ x-webhooks: type: string comment: type: string - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - reviewers: &795 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + reviewers: &810 type: array items: type: object @@ -131111,7 +131878,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &796 + workflow_job_run: &811 type: object properties: conclusion: @@ -131842,18 +132609,18 @@ x-webhooks: type: string enum: - rejected - approver: *794 + approver: *809 comment: type: string - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - reviewers: *795 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + reviewers: *810 sender: *4 since: type: string - workflow_job_run: *796 + workflow_job_run: *811 workflow_job_runs: type: array items: @@ -132557,13 +133324,13 @@ x-webhooks: type: string enum: - requested - enterprise: *780 + enterprise: *795 environment: type: string - installation: *781 - organization: *782 - repository: *783 - requestor: &802 + installation: *796 + organization: *797 + repository: *798 + requestor: &817 title: User type: object nullable: true @@ -134452,12 +135219,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - workflow: *797 + workflow: *812 workflow_run: title: Deployment Workflow Run type: object @@ -135137,7 +135904,7 @@ x-webhooks: type: string enum: - answered - answer: &800 + answer: &815 type: object properties: author_association: @@ -135294,11 +136061,11 @@ x-webhooks: - created_at - updated_at - body - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -135425,11 +136192,11 @@ x-webhooks: - from required: - category - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -135512,11 +136279,11 @@ x-webhooks: type: string enum: - closed - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -135598,7 +136365,7 @@ x-webhooks: type: string enum: - created - comment: &799 + comment: &814 type: object properties: author_association: @@ -135755,11 +136522,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -135842,12 +136609,12 @@ x-webhooks: type: string enum: - deleted - comment: *799 - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + comment: *814 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -135942,12 +136709,12 @@ x-webhooks: - from required: - body - comment: *799 - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + comment: *814 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136031,11 +136798,11 @@ x-webhooks: type: string enum: - created - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136117,11 +136884,11 @@ x-webhooks: type: string enum: - deleted - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136221,11 +136988,11 @@ x-webhooks: type: string required: - from - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136307,10 +137074,10 @@ x-webhooks: type: string enum: - labeled - discussion: *798 - enterprise: *780 - installation: *781 - label: &801 + discussion: *813 + enterprise: *795 + installation: *796 + label: &816 title: Label type: object properties: @@ -136342,8 +137109,8 @@ x-webhooks: - color - default - description - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136426,11 +137193,11 @@ x-webhooks: type: string enum: - locked - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136512,11 +137279,11 @@ x-webhooks: type: string enum: - pinned - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136598,11 +137365,11 @@ x-webhooks: type: string enum: - reopened - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136687,16 +137454,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *798 - new_repository: *783 + new_discussion: *813 + new_repository: *798 required: - new_discussion - new_repository - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136779,10 +137546,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *798 - old_answer: *800 - organization: *782 - repository: *783 + discussion: *813 + old_answer: *815 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136864,12 +137631,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *798 - enterprise: *780 - installation: *781 - label: *801 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -136952,11 +137719,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -137038,11 +137805,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *798 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + discussion: *813 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -137115,7 +137882,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *780 + enterprise: *795 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -137775,9 +138542,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - forkee @@ -137923,9 +138690,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pages: description: The pages that were updated. type: array @@ -137962,7 +138729,7 @@ x-webhooks: - action - sha - html_url - repository: *783 + repository: *798 sender: *4 required: - pages @@ -138038,10 +138805,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories: &803 + organization: *797 + repositories: &818 description: An array of repository objects that the installation can access. type: array @@ -138067,8 +138834,8 @@ x-webhooks: - name - full_name - private - repository: *783 - requester: *802 + repository: *798 + requester: *817 sender: *4 required: - action @@ -138143,11 +138910,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories: *803 - repository: *783 + organization: *797 + repositories: *818 + repository: *798 requester: nullable: true sender: *4 @@ -138223,11 +138990,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories: *803 - repository: *783 + organization: *797 + repositories: *818 + repository: *798 requester: nullable: true sender: *4 @@ -138303,10 +139070,10 @@ x-webhooks: type: string enum: - added - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories_added: &804 + organization: *797 + repositories_added: &819 description: An array of repository objects, which were added to the installation. type: array @@ -138352,15 +139119,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *783 - repository_selection: &805 + repository: *798 + repository_selection: &820 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *802 + requester: *817 sender: *4 required: - action @@ -138439,10 +139206,10 @@ x-webhooks: type: string enum: - removed - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories_added: *804 + organization: *797 + repositories_added: *819 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -138469,9 +139236,9 @@ x-webhooks: - name - full_name - private - repository: *783 - repository_selection: *805 - requester: *802 + repository: *798 + repository_selection: *820 + requester: *817 sender: *4 required: - action @@ -138550,11 +139317,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories: *803 - repository: *783 + organization: *797 + repositories: *818 + repository: *798 requester: nullable: true sender: *4 @@ -138732,10 +139499,10 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 target_type: type: string @@ -138814,11 +139581,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *780 + enterprise: *795 installation: *22 - organization: *782 - repositories: *803 - repository: *783 + organization: *797 + repositories: *818 + repository: *798 requester: nullable: true sender: *4 @@ -138992,15 +139759,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *592 - required: *593 + properties: *594 + required: *595 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *594 - required: *595 + properties: *596 + required: *597 nullable: true user: title: User @@ -139085,8 +139852,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -139875,8 +140642,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140225,8 +140992,8 @@ x-webhooks: - state - locked - assignee - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -140306,7 +141073,7 @@ x-webhooks: type: string enum: - deleted - comment: &806 + comment: &821 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -140463,15 +141230,15 @@ x-webhooks: description: Context around who pinned an issue comment and when it was pinned. type: object - properties: *592 - required: *593 + properties: *594 + required: *595 nullable: true minimized: title: Minimized Issue Comment description: Details about why an issue comment was minimized. type: object - properties: *594 - required: *595 + properties: *596 + required: *597 nullable: true required: - url @@ -140486,8 +141253,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141272,8 +142039,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141624,8 +142391,8 @@ x-webhooks: - state - locked - assignee - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -141705,7 +142472,7 @@ x-webhooks: type: string enum: - edited - changes: &836 + changes: &851 description: The changes to the comment. type: object properties: @@ -141717,9 +142484,9 @@ x-webhooks: type: string required: - from - comment: *806 - enterprise: *780 - installation: *781 + comment: *821 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -142507,8 +143274,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142857,8 +143624,8 @@ x-webhooks: - state - locked - assignee - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -142939,9 +143706,9 @@ x-webhooks: type: string enum: - pinned - comment: *806 - enterprise: *780 - installation: *781 + comment: *821 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143731,8 +144498,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144083,8 +144850,8 @@ x-webhooks: - state - locked - assignee - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -144164,9 +144931,9 @@ x-webhooks: type: string enum: - unpinned - comment: *806 - enterprise: *780 - installation: *781 + comment: *821 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144956,8 +145723,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145308,8 +146075,8 @@ x-webhooks: - state - locked - assignee - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -145398,9 +146165,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -145489,9 +146256,9 @@ x-webhooks: type: number blocking_issue: *88 blocking_issue_repo: *82 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -145579,9 +146346,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -145670,9 +146437,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -145752,10 +146519,10 @@ x-webhooks: type: string enum: - assigned - assignee: *802 - enterprise: *780 - installation: *781 - issue: &807 + assignee: *817 + enterprise: *795 + installation: *796 + issue: &822 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -146547,11 +147314,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146668,8 +147435,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -146749,8 +147516,8 @@ x-webhooks: type: string enum: - closed - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -147547,11 +148314,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147803,8 +148570,8 @@ x-webhooks: required: - state - closed_at - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -147883,8 +148650,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -148672,11 +149439,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148792,8 +149559,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -148872,8 +149639,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -149683,11 +150450,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149782,7 +150549,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &808 + milestone: &823 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149920,8 +150687,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -150020,8 +150787,8 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150813,11 +151580,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150934,9 +151701,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *801 - organization: *782 - repository: *783 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -151016,9 +151783,9 @@ x-webhooks: type: string enum: - field_added - enterprise: *780 - installation: *781 - issue: *807 + enterprise: *795 + installation: *796 + issue: *822 issue_field: type: object description: The issue field whose value was set or updated on the @@ -151172,8 +151939,8 @@ x-webhooks: - id required: - from - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -151253,9 +152020,9 @@ x-webhooks: type: string enum: - field_removed - enterprise: *780 - installation: *781 - issue: *807 + enterprise: *795 + installation: *796 + issue: *822 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -151336,8 +152103,8 @@ x-webhooks: nullable: true required: - id - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -151417,8 +152184,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152209,11 +152976,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152330,9 +153097,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *801 - organization: *782 - repository: *783 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -152412,8 +153179,8 @@ x-webhooks: type: string enum: - locked - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -153228,11 +153995,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153326,8 +154093,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -153406,8 +154173,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154216,11 +154983,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154314,9 +155081,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *808 - organization: *782 - repository: *783 + milestone: *823 + organization: *797 + repository: *798 sender: *4 required: - action @@ -155179,11 +155946,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155764,8 +156531,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156549,11 +157316,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156677,8 +157444,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -156758,9 +157525,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *780 - installation: *781 - issue: &809 + enterprise: *795 + installation: *796 + issue: &824 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -157546,11 +158313,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157666,8 +158433,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -157746,8 +158513,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158560,11 +159327,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158659,8 +159426,8 @@ x-webhooks: user_view_type: type: string type: *258 - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -159529,11 +160296,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160128,11 +160895,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *780 - installation: *781 - issue: *809 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + issue: *824 + organization: *797 + repository: *798 sender: *4 required: - action @@ -160212,12 +160979,12 @@ x-webhooks: type: string enum: - typed - enterprise: *780 - installation: *781 - issue: *807 + enterprise: *795 + installation: *796 + issue: *822 type: *258 - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -160298,7 +161065,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &839 + assignee: &854 title: User type: object nullable: true @@ -160368,11 +161135,11 @@ x-webhooks: required: - login - id - enterprise: *780 - installation: *781 - issue: *807 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + issue: *822 + organization: *797 + repository: *798 sender: *4 required: - action @@ -160451,12 +161218,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *780 - installation: *781 - issue: *807 - label: *801 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + issue: *822 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -160536,8 +161303,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -161350,11 +162117,11 @@ x-webhooks: properties: *89 required: *90 nullable: true - sub_issues_summary: *713 - issue_dependencies_summary: *714 + sub_issues_summary: *728 + issue_dependencies_summary: *729 issue_field_values: type: array - items: *576 + items: *578 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161448,8 +162215,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161529,11 +162296,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *780 - installation: *781 - issue: *809 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + issue: *824 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161612,12 +162379,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *780 - installation: *781 - issue: *807 + enterprise: *795 + installation: *796 + issue: *822 type: *258 - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161697,11 +162464,11 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - label: *801 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161779,11 +162546,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - label: *801 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161893,11 +162660,11 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - label: *801 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + label: *816 + organization: *797 + repository: *798 sender: *4 required: - action @@ -161979,9 +162746,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *780 - installation: *781 - marketplace_purchase: &810 + enterprise: *795 + installation: *796 + marketplace_purchase: &825 title: Marketplace Purchase type: object required: @@ -162064,8 +162831,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *782 - previous_marketplace_purchase: &811 + organization: *797 + previous_marketplace_purchase: &826 title: Marketplace Purchase type: object properties: @@ -162145,7 +162912,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *783 + repository: *798 sender: *4 required: - action @@ -162225,10 +162992,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *780 - installation: *781 - marketplace_purchase: *810 - organization: *782 + enterprise: *795 + installation: *796 + marketplace_purchase: *825 + organization: *797 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162311,7 +163078,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *783 + repository: *798 sender: *4 required: - action @@ -162393,10 +163160,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *780 - installation: *781 - marketplace_purchase: *810 - organization: *782 + enterprise: *795 + installation: *796 + marketplace_purchase: *825 + organization: *797 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162478,7 +163245,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *783 + repository: *798 sender: *4 required: - action @@ -162559,8 +163326,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 marketplace_purchase: title: Marketplace Purchase type: object @@ -162642,9 +163409,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *782 - previous_marketplace_purchase: *811 - repository: *783 + organization: *797 + previous_marketplace_purchase: *826 + repository: *798 sender: *4 required: - action @@ -162724,12 +163491,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *780 - installation: *781 - marketplace_purchase: *810 - organization: *782 - previous_marketplace_purchase: *811 - repository: *783 + enterprise: *795 + installation: *796 + marketplace_purchase: *825 + organization: *797 + previous_marketplace_purchase: *826 + repository: *798 sender: *4 required: - action @@ -162831,11 +163598,11 @@ x-webhooks: type: string required: - to - enterprise: *780 - installation: *781 - member: *802 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + member: *817 + organization: *797 + repository: *798 sender: *4 required: - action @@ -162935,11 +163702,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *780 - installation: *781 - member: *802 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + member: *817 + organization: *797 + repository: *798 sender: *4 required: - action @@ -163018,11 +163785,11 @@ x-webhooks: type: string enum: - removed - enterprise: *780 - installation: *781 - member: *802 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + member: *817 + organization: *797 + repository: *798 sender: *4 required: - action @@ -163100,11 +163867,11 @@ x-webhooks: type: string enum: - added - enterprise: *780 - installation: *781 - member: *802 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + member: *817 + organization: *797 + repository: *798 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163180,7 +163947,7 @@ x-webhooks: required: - login - id - team: &812 + team: &827 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -163403,11 +164170,11 @@ x-webhooks: type: string enum: - removed - enterprise: *780 - installation: *781 - member: *802 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + member: *817 + organization: *797 + repository: *798 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163484,7 +164251,7 @@ x-webhooks: required: - login - id - team: *812 + team: *827 required: - action - scope @@ -163566,8 +164333,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *781 - merge_group: &814 + installation: *796 + merge_group: &829 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -163586,15 +164353,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *813 + head_commit: *828 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -163680,10 +164447,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *781 - merge_group: *814 - organization: *782 - repository: *783 + installation: *796 + merge_group: *829 + organization: *797 + repository: *798 sender: *4 required: - action @@ -163756,7 +164523,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 + enterprise: *795 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163865,17 +164632,17 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *781 - organization: *782 + installation: *796 + organization: *797 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *815 - required: *816 - x-github-breaking-changes: *817 + properties: *830 + required: *831 + x-github-breaking-changes: *832 nullable: true sender: *4 required: @@ -163956,11 +164723,11 @@ x-webhooks: type: string enum: - closed - enterprise: *780 - installation: *781 - milestone: *808 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + milestone: *823 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164039,9 +164806,9 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - milestone: &818 + enterprise: *795 + installation: *796 + milestone: &833 title: Milestone description: A collection of related issues and pull requests. type: object @@ -164178,8 +164945,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164258,11 +165025,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - milestone: *808 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + milestone: *823 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164372,11 +165139,11 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - milestone: *808 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + milestone: *823 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164456,11 +165223,11 @@ x-webhooks: type: string enum: - opened - enterprise: *780 - installation: *781 - milestone: *818 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + milestone: *833 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164539,11 +165306,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *802 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + blocked_user: *817 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164622,11 +165389,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *802 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + blocked_user: *817 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164705,9 +165472,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - membership: &819 + enterprise: *795 + installation: *796 + membership: &834 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164814,8 +165581,8 @@ x-webhooks: - role - organization_url - user - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164893,11 +165660,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *780 - installation: *781 - membership: *819 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + membership: *834 + organization: *797 + repository: *798 sender: *4 required: - action @@ -164976,8 +165743,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -165093,10 +165860,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 - user: *802 + user: *817 required: - action - invitation @@ -165174,11 +165941,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *780 - installation: *781 - membership: *819 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + membership: *834 + organization: *797 + repository: *798 sender: *4 required: - action @@ -165265,11 +166032,11 @@ x-webhooks: properties: from: type: string - enterprise: *780 - installation: *781 - membership: *819 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + membership: *834 + organization: *797 + repository: *798 sender: *4 required: - action @@ -165346,9 +166113,9 @@ x-webhooks: type: string enum: - published - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 package: description: Information about the package. type: object @@ -165847,7 +166614,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &820 + items: &835 title: Ruby Gems metadata type: object properties: @@ -165942,7 +166709,7 @@ x-webhooks: - owner - package_version - registry - repository: *783 + repository: *798 sender: *4 required: - action @@ -166018,9 +166785,9 @@ x-webhooks: type: string enum: - updated - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 package: description: Information about the package. type: object @@ -166373,7 +167140,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *820 + items: *835 source_url: type: string format: uri @@ -166443,7 +167210,7 @@ x-webhooks: - owner - package_version - registry - repository: *783 + repository: *798 sender: *4 required: - action @@ -166619,12 +167386,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *780 + enterprise: *795 id: type: integer - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - id @@ -166701,7 +167468,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &821 + personal_access_token_request: &836 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166847,10 +167614,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *780 - organization: *782 + enterprise: *795 + organization: *797 sender: *4 - installation: *781 + installation: *796 required: - action - personal_access_token_request @@ -166927,11 +167694,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *821 - enterprise: *780 - organization: *782 + personal_access_token_request: *836 + enterprise: *795 + organization: *797 sender: *4 - installation: *781 + installation: *796 required: - action - personal_access_token_request @@ -167007,11 +167774,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *821 - enterprise: *780 - organization: *782 + personal_access_token_request: *836 + enterprise: *795 + organization: *797 sender: *4 - installation: *781 + installation: *796 required: - action - personal_access_token_request @@ -167086,11 +167853,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *821 - organization: *782 - enterprise: *780 + personal_access_token_request: *836 + organization: *797 + enterprise: *795 sender: *4 - installation: *781 + installation: *796 required: - action - personal_access_token_request @@ -167195,7 +167962,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *822 + last_response: *837 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -167227,8 +167994,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 zen: description: Random string of GitHub zen. @@ -167473,10 +168240,10 @@ x-webhooks: - from required: - note - enterprise: *780 - installation: *781 - organization: *782 - project_card: &823 + enterprise: *795 + installation: *796 + organization: *797 + project_card: &838 title: Project Card type: object properties: @@ -167595,7 +168362,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *783 + repository: *798 sender: *4 required: - action @@ -167676,11 +168443,11 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - project_card: *823 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project_card: *838 + repository: *798 sender: *4 required: - action @@ -167760,9 +168527,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 project_card: title: Project Card type: object @@ -167890,9 +168657,9 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *815 - required: *816 - x-github-breaking-changes: *817 + properties: *830 + required: *831 + x-github-breaking-changes: *832 nullable: true sender: *4 required: @@ -167986,11 +168753,11 @@ x-webhooks: - from required: - note - enterprise: *780 - installation: *781 - organization: *782 - project_card: *823 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project_card: *838 + repository: *798 sender: *4 required: - action @@ -168084,9 +168851,9 @@ x-webhooks: - from required: - column_id - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 project_card: allOf: - title: Project Card @@ -168276,7 +169043,7 @@ x-webhooks: type: string required: - after_id - repository: *783 + repository: *798 sender: *4 required: - action @@ -168356,10 +169123,10 @@ x-webhooks: type: string enum: - closed - enterprise: *780 - installation: *781 - organization: *782 - project: &825 + enterprise: *795 + installation: *796 + organization: *797 + project: &840 title: Project type: object properties: @@ -168483,7 +169250,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *783 + repository: *798 sender: *4 required: - action @@ -168563,10 +169330,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - project_column: &824 + enterprise: *795 + installation: *796 + organization: *797 + project_column: &839 title: Project Column type: object properties: @@ -168605,7 +169372,7 @@ x-webhooks: - name - created_at - updated_at - repository: *783 + repository: *798 sender: *4 required: - action @@ -168684,19 +169451,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - project_column: *824 + enterprise: *795 + installation: *796 + organization: *797 + project_column: *839 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *815 - required: *816 - x-github-breaking-changes: *817 + properties: *830 + required: *831 + x-github-breaking-changes: *832 nullable: true sender: *4 required: @@ -168786,11 +169553,11 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - organization: *782 - project_column: *824 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project_column: *839 + repository: *798 sender: *4 required: - action @@ -168870,11 +169637,11 @@ x-webhooks: type: string enum: - moved - enterprise: *780 - installation: *781 - organization: *782 - project_column: *824 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project_column: *839 + repository: *798 sender: *4 required: - action @@ -168954,11 +169721,11 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - project: *825 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project: *840 + repository: *798 sender: *4 required: - action @@ -169038,19 +169805,19 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - project: *825 + enterprise: *795 + installation: *796 + organization: *797 + project: *840 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *815 - required: *816 - x-github-breaking-changes: *817 + properties: *830 + required: *831 + x-github-breaking-changes: *832 nullable: true sender: *4 required: @@ -169152,11 +169919,11 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - organization: *782 - project: *825 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project: *840 + repository: *798 sender: *4 required: - action @@ -169235,11 +170002,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *780 - installation: *781 - organization: *782 - project: *825 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + project: *840 + repository: *798 sender: *4 required: - action @@ -169320,8 +170087,8 @@ x-webhooks: type: string enum: - closed - installation: *781 - organization: *782 + installation: *796 + organization: *797 projects_v2: *292 sender: *4 required: @@ -169403,8 +170170,8 @@ x-webhooks: type: string enum: - created - installation: *781 - organization: *782 + installation: *796 + organization: *797 projects_v2: *292 sender: *4 required: @@ -169486,8 +170253,8 @@ x-webhooks: type: string enum: - deleted - installation: *781 - organization: *782 + installation: *796 + organization: *797 projects_v2: *292 sender: *4 required: @@ -169605,8 +170372,8 @@ x-webhooks: type: string to: type: string - installation: *781 - organization: *782 + installation: *796 + organization: *797 projects_v2: *292 sender: *4 required: @@ -169690,7 +170457,7 @@ x-webhooks: type: string enum: - archived - changes: &829 + changes: &844 type: object properties: archived_at: @@ -169704,9 +170471,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *781 - organization: *782 - projects_v2_item: &826 + installation: *796 + organization: *797 + projects_v2_item: &841 title: Projects v2 Item description: An item belonging to a project type: object @@ -169841,9 +170608,9 @@ x-webhooks: nullable: true to: type: string - installation: *781 - organization: *782 - projects_v2_item: *826 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -169925,9 +170692,9 @@ x-webhooks: type: string enum: - created - installation: *781 - organization: *782 - projects_v2_item: *826 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -170008,9 +170775,9 @@ x-webhooks: type: string enum: - deleted - installation: *781 - organization: *782 - projects_v2_item: *826 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -170116,7 +170883,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &827 + - &842 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -170138,7 +170905,7 @@ x-webhooks: required: - id - name - - &828 + - &843 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -170172,8 +170939,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *827 - - *828 + - *842 + - *843 required: - field_value - type: object @@ -170189,9 +170956,9 @@ x-webhooks: nullable: true required: - body - installation: *781 - organization: *782 - projects_v2_item: *826 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -170286,9 +171053,9 @@ x-webhooks: to: type: string nullable: true - installation: *781 - organization: *782 - projects_v2_item: *826 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -170371,10 +171138,10 @@ x-webhooks: type: string enum: - restored - changes: *829 - installation: *781 - organization: *782 - projects_v2_item: *826 + changes: *844 + installation: *796 + organization: *797 + projects_v2_item: *841 sender: *4 required: - action @@ -170456,8 +171223,8 @@ x-webhooks: type: string enum: - reopened - installation: *781 - organization: *782 + installation: *796 + organization: *797 projects_v2: *292 sender: *4 required: @@ -170539,14 +171306,14 @@ x-webhooks: type: string enum: - created - installation: *781 - organization: *782 - projects_v2_status_update: &832 + installation: *796 + organization: *797 + projects_v2_status_update: &847 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *830 - required: *831 + properties: *845 + required: *846 sender: *4 required: - action @@ -170627,9 +171394,9 @@ x-webhooks: type: string enum: - deleted - installation: *781 - organization: *782 - projects_v2_status_update: *832 + installation: *796 + organization: *797 + projects_v2_status_update: *847 sender: *4 required: - action @@ -170765,9 +171532,9 @@ x-webhooks: type: string format: date nullable: true - installation: *781 - organization: *782 - projects_v2_status_update: *832 + installation: *796 + organization: *797 + projects_v2_status_update: *847 sender: *4 required: - action @@ -170838,10 +171605,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - repository @@ -170918,13 +171685,13 @@ x-webhooks: type: string enum: - assigned - assignee: *802 - enterprise: *780 - installation: *781 - number: &833 + assignee: *817 + enterprise: *795 + installation: *796 + number: &848 description: The pull request number. type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -173229,7 +173996,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -173326,11 +174093,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -175630,7 +176397,7 @@ x-webhooks: - draft reason: type: string - repository: *783 + repository: *798 sender: *4 required: - action @@ -175727,11 +176494,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -178031,7 +178798,7 @@ x-webhooks: - draft reason: type: string - repository: *783 + repository: *798 sender: *4 required: - action @@ -178128,13 +178895,13 @@ x-webhooks: type: string enum: - closed - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: &834 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: &849 allOf: - - *628 + - *630 - type: object properties: allow_auto_merge: @@ -178196,7 +178963,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *783 + repository: *798 sender: *4 required: - action @@ -178277,12 +179044,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: *834 - repository: *783 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: *849 + repository: *798 sender: *4 required: - action @@ -178362,11 +179129,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *780 - milestone: *612 - number: *833 - organization: *782 - pull_request: &835 + enterprise: *795 + milestone: *614 + number: *848 + organization: *797 + pull_request: &850 title: Pull Request type: object properties: @@ -180693,7 +181460,7 @@ x-webhooks: - active_lock_reason - draft version: '2026-03-10' - repository: *783 + repository: *798 sender: *4 required: - action @@ -180772,11 +181539,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -183080,7 +183847,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *783 + repository: *798 sender: *4 required: - action @@ -183212,12 +183979,12 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: *834 - repository: *783 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: *849 + repository: *798 sender: *4 required: - action @@ -183297,11 +184064,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -185590,7 +186357,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -185678,11 +186445,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *780 - installation: *781 - label: *801 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + label: *816 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -187986,7 +188753,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -188082,10 +188849,10 @@ x-webhooks: type: string enum: - locked - enterprise: *780 - installation: *781 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -190387,7 +191154,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -190482,12 +191249,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *780 - milestone: *612 - number: *833 - organization: *782 - pull_request: *835 - repository: *783 + enterprise: *795 + milestone: *614 + number: *848 + organization: *797 + pull_request: *850 + repository: *798 sender: *4 required: - action @@ -190566,12 +191333,12 @@ x-webhooks: type: string enum: - opened - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: *834 - repository: *783 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: *849 + repository: *798 sender: *4 required: - action @@ -190652,12 +191419,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: *834 - repository: *783 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: *849 + repository: *798 sender: *4 required: - action @@ -190737,12 +191504,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *780 - installation: *781 - number: *833 - organization: *782 - pull_request: *834 - repository: *783 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 + pull_request: *849 + repository: *798 sender: *4 required: - action @@ -191108,9 +191875,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: type: object properties: @@ -193302,7 +194069,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *783 + repository: *798 sender: *4 required: - action @@ -193397,7 +194164,7 @@ x-webhooks: type: string enum: - deleted - comment: &837 + comment: &852 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -193682,9 +194449,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: type: object properties: @@ -195864,7 +196631,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *783 + repository: *798 sender: *4 required: - action @@ -195959,11 +196726,11 @@ x-webhooks: type: string enum: - edited - changes: *836 - comment: *837 - enterprise: *780 - installation: *781 - organization: *782 + changes: *851 + comment: *852 + enterprise: *795 + installation: *796 + organization: *797 pull_request: type: object properties: @@ -198146,7 +198913,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *783 + repository: *798 sender: *4 required: - action @@ -198242,9 +199009,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: title: Simple Pull Request type: object @@ -200439,7 +201206,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *783 + repository: *798 review: description: The review that was affected. type: object @@ -200701,9 +201468,9 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: title: Simple Pull Request type: object @@ -202757,8 +203524,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *783 - review: &838 + repository: *798 + review: &853 description: The review that was affected. type: object properties: @@ -202999,12 +203766,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: description: The pull request number. type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -205309,7 +206076,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 requested_reviewer: title: User type: object @@ -205393,12 +206160,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: description: The pull request number. type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -207710,7 +208477,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207925,12 +208692,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: description: The pull request number. type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -210237,7 +211004,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 requested_reviewer: title: User type: object @@ -210322,12 +211089,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *780 - installation: *781 + enterprise: *795 + installation: *796 number: description: The pull request number. type: integer - organization: *782 + organization: *797 pull_request: title: Pull Request type: object @@ -212625,7 +213392,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212829,9 +213596,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: title: Simple Pull Request type: object @@ -215028,8 +215795,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *783 - review: *838 + repository: *798 + review: *853 sender: *4 required: - action @@ -215124,9 +215891,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: title: Simple Pull Request type: object @@ -217218,7 +217985,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *783 + repository: *798 sender: *4 thread: type: object @@ -217613,9 +218380,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 pull_request: title: Simple Pull Request type: object @@ -219693,7 +220460,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *783 + repository: *798 sender: *4 thread: type: object @@ -220085,10 +220852,10 @@ x-webhooks: type: string enum: - stacked - enterprise: *780 - installation: *781 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -222392,7 +223159,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -222493,10 +223260,10 @@ x-webhooks: type: string before: type: string - enterprise: *780 - installation: *781 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -224789,7 +225556,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -224886,11 +225653,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *839 - enterprise: *780 - installation: *781 - number: *833 - organization: *782 + assignee: *854 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -227195,7 +227962,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -227289,11 +228056,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *780 - installation: *781 - label: *801 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + label: *816 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -229588,7 +230355,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -229684,10 +230451,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *780 - installation: *781 - number: *833 - organization: *782 + enterprise: *795 + installation: *796 + number: *848 + organization: *797 pull_request: title: Pull Request type: object @@ -231974,7 +232741,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *783 + repository: *798 sender: *4 required: - action @@ -232189,7 +232956,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *780 + enterprise: *795 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -232281,8 +233048,8 @@ x-webhooks: - url - author - committer - installation: *781 - organization: *782 + installation: *796 + organization: *797 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -232868,9 +233635,9 @@ x-webhooks: type: string enum: - published - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 registry_package: type: object properties: @@ -233316,7 +234083,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *820 + items: *835 summary: type: string tag_name: @@ -233370,7 +234137,7 @@ x-webhooks: - owner - package_version - registry - repository: *783 + repository: *798 sender: *4 required: - action @@ -233448,9 +234215,9 @@ x-webhooks: type: string enum: - updated - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 registry_package: type: object properties: @@ -233758,7 +234525,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *820 + items: *835 summary: type: string tag_name: @@ -233807,7 +234574,7 @@ x-webhooks: - owner - package_version - registry - repository: *783 + repository: *798 sender: *4 required: - action @@ -233884,10 +234651,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - release: &840 + enterprise: *795 + installation: *796 + organization: *797 + release: &855 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -234205,7 +234972,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *783 + repository: *798 sender: *4 required: - action @@ -234282,11 +235049,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - release: *840 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + release: *855 + repository: *798 sender: *4 required: - action @@ -234403,11 +235170,11 @@ x-webhooks: type: boolean required: - to - enterprise: *780 - installation: *781 - organization: *782 - release: *840 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + release: *855 + repository: *798 sender: *4 required: - action @@ -234485,9 +235252,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -234809,7 +235576,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *783 + repository: *798 sender: *4 required: - action @@ -234885,10 +235652,10 @@ x-webhooks: type: string enum: - published - enterprise: *780 - installation: *781 - organization: *782 - release: &841 + enterprise: *795 + installation: *796 + organization: *797 + release: &856 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -235207,7 +235974,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *783 + repository: *798 sender: *4 required: - action @@ -235283,11 +236050,11 @@ x-webhooks: type: string enum: - released - enterprise: *780 - installation: *781 - organization: *782 - release: *840 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + release: *855 + repository: *798 sender: *4 required: - action @@ -235363,11 +236130,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *780 - installation: *781 - organization: *782 - release: *841 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + release: *856 + repository: *798 sender: *4 required: - action @@ -235443,11 +236210,11 @@ x-webhooks: type: string enum: - published - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - repository_advisory: *700 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + repository_advisory: *715 sender: *4 required: - action @@ -235523,11 +236290,11 @@ x-webhooks: type: string enum: - reported - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - repository_advisory: *700 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + repository_advisory: *715 sender: *4 required: - action @@ -235603,10 +236370,10 @@ x-webhooks: type: string enum: - archived - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -235683,10 +236450,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -235764,10 +236531,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -235851,10 +236618,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -235966,10 +236733,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -236041,10 +236808,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 status: type: string @@ -236125,10 +236892,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -236205,10 +236972,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -236302,10 +237069,10 @@ x-webhooks: - name required: - repository - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -236385,10 +237152,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 repository_ruleset: *341 sender: *4 required: @@ -236467,10 +237234,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 repository_ruleset: *341 sender: *4 required: @@ -236549,10 +237316,10 @@ x-webhooks: type: string enum: - edited - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 repository_ruleset: *341 changes: type: object @@ -236614,16 +237381,16 @@ x-webhooks: properties: added: type: array - items: *649 + items: *651 deleted: type: array - items: *649 + items: *651 updated: type: array items: type: object properties: - rule: *649 + rule: *651 changes: type: object properties: @@ -236857,10 +237624,10 @@ x-webhooks: - from required: - owner - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -236938,10 +237705,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237019,7 +237786,7 @@ x-webhooks: type: string enum: - create - alert: &842 + alert: &857 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -237141,10 +237908,10 @@ x-webhooks: enum: - auto_dismissed - open - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237350,10 +238117,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237431,11 +238198,11 @@ x-webhooks: type: string enum: - reopen - alert: *842 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *857 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237634,10 +238401,10 @@ x-webhooks: enum: - fixed - open - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237715,7 +238482,7 @@ x-webhooks: type: string enum: - assigned - alert: &844 + alert: &859 type: object properties: number: *188 @@ -237857,12 +238624,12 @@ x-webhooks: properties: *20 required: *21 nullable: true - metadata: *843 + metadata: *858 assignee: *4 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -237940,11 +238707,11 @@ x-webhooks: type: string enum: - created - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238025,11 +238792,11 @@ x-webhooks: type: string enum: - created - alert: *844 - installation: *781 - location: *845 - organization: *782 - repository: *783 + alert: *859 + installation: *796 + location: *860 + organization: *797 + repository: *798 sender: *4 required: - location @@ -238267,11 +239034,11 @@ x-webhooks: type: string enum: - metadata_created - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238348,11 +239115,11 @@ x-webhooks: type: string enum: - metadata_removed - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238429,11 +239196,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238511,11 +239278,11 @@ x-webhooks: type: string enum: - reopened - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238593,11 +239360,11 @@ x-webhooks: type: string enum: - resolved - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238675,12 +239442,12 @@ x-webhooks: type: string enum: - unassigned - alert: *844 + alert: *859 assignee: *4 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238758,11 +239525,11 @@ x-webhooks: type: string enum: - validated - alert: *844 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + alert: *859 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -238888,10 +239655,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *783 - enterprise: *780 - installation: *781 - organization: *782 + repository: *798 + enterprise: *795 + installation: *796 + organization: *797 sender: *4 required: - action @@ -238969,11 +239736,11 @@ x-webhooks: type: string enum: - published - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - security_advisory: &846 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + security_advisory: &861 description: The details of the security advisory, including summary, description, and severity. type: object @@ -239174,11 +239941,11 @@ x-webhooks: type: string enum: - updated - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 - security_advisory: *846 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 + security_advisory: *861 sender: *4 required: - action @@ -239251,10 +240018,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -239447,10 +240214,10 @@ x-webhooks: type: object properties: security_and_analysis: *314 - enterprise: *780 - installation: *781 - organization: *782 - repository: *359 + enterprise: *795 + installation: *796 + organization: *797 + repository: *361 sender: *4 required: - changes @@ -239528,12 +240295,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: &847 + sponsorship: &862 type: object properties: created_at: @@ -239834,12 +240601,12 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: *847 + sponsorship: *862 required: - action - sponsorship @@ -239927,12 +240694,12 @@ x-webhooks: type: string required: - from - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: *847 + sponsorship: *862 required: - action - changes @@ -240009,17 +240776,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &848 + effective_date: &863 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: *847 + sponsorship: *862 required: - action - sponsorship @@ -240093,7 +240860,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &849 + changes: &864 type: object properties: tier: @@ -240137,13 +240904,13 @@ x-webhooks: - from required: - tier - effective_date: *848 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + effective_date: *863 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: *847 + sponsorship: *862 required: - action - changes @@ -240220,13 +240987,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *849 - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + changes: *864 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - sponsorship: *847 + sponsorship: *862 required: - action - changes @@ -240300,10 +241067,10 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240386,10 +241153,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -240809,15 +241576,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *780 + enterprise: *795 id: description: The unique identifier of the status. type: integer - installation: *781 + installation: *796 name: type: string - organization: *782 - repository: *783 + organization: *797 + repository: *798 sender: *4 sha: description: The Commit SHA. @@ -240932,9 +241699,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -241023,9 +241790,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -241114,9 +241881,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -241205,9 +241972,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *88 - installation: *781 - organization: *782 - repository: *783 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -241283,12 +242050,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 - team: &850 + team: &865 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -241511,9 +242278,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 repository: title: Repository description: A git repository @@ -241971,7 +242738,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *850 + team: *865 required: - action - team @@ -242047,9 +242814,9 @@ x-webhooks: type: string enum: - created - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 repository: title: Repository description: A git repository @@ -242507,7 +243274,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *850 + team: *865 required: - action - team @@ -242584,9 +243351,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 repository: title: Repository description: A git repository @@ -243044,7 +243811,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *850 + team: *865 required: - action - team @@ -243188,9 +243955,9 @@ x-webhooks: - from required: - permissions - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 repository: title: Repository description: A git repository @@ -243648,7 +244415,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *850 + team: *865 required: - action - changes @@ -243726,9 +244493,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *780 - installation: *781 - organization: *782 + enterprise: *795 + installation: *796 + organization: *797 repository: title: Repository description: A git repository @@ -244186,7 +244953,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *850 + team: *865 required: - action - team @@ -244262,10 +245029,10 @@ x-webhooks: type: string enum: - started - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 required: - action @@ -244338,16 +245105,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *780 + enterprise: *795 inputs: type: object nullable: true additionalProperties: true - installation: *781 - organization: *782 + installation: *796 + organization: *797 ref: type: string - repository: *783 + repository: *798 sender: *4 workflow: type: string @@ -244429,10 +245196,10 @@ x-webhooks: type: string enum: - completed - enterprise: *780 - installation: *781 - organization: *782 - repository: *783 + enterprise: *795 + installation: *796 + organization: *797 + repository: *798 sender: *4 workflow_job: allOf: @@ -244669,7 +245436,7 @@ x-webhooks: type: string required: - conclusion - deployment: *521 + deployment: *523 required: - action - repository @@ -244748,10 +245515,10 @@ x-webhooks: type: string enum: - in_progress - {"code":"deadline_exceeded","msg":"operation timed out"}