diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 04664ec7e0..497839f020 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -4873,15 +4873,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": [ { @@ -4911,21 +4911,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": [ { @@ -4961,21 +4964,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": [ { @@ -5008,21 +5014,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": [ { @@ -5055,21 +5064,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": [ { @@ -5099,21 +5111,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": [ { @@ -5149,8 +5164,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36378,6 +36396,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", @@ -73086,6 +73453,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", @@ -115408,7 +116136,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", @@ -135573,6 +136301,249 @@ ], "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." }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "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": { @@ -323429,6 +324400,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", @@ -346033,6 +347145,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.", @@ -347122,6 +348275,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-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 3ed1556a70..7d2efa7375 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -3707,15 +3707,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: @@ -3734,19 +3738,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" @@ -3767,18 +3776,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: @@ -3799,18 +3814,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" @@ -3830,18 +3851,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: @@ -3860,18 +3887,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" @@ -3892,6 +3925,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 @@ -26768,6 +26804,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 @@ -53453,6 +53728,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 @@ -83723,7 +84241,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 @@ -98825,6 +99343,187 @@ components: 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. + 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 + - 'null' + description: The start delimiter regex for the custom pattern. + end_delimiter: + type: + - string + - 'null' + description: The end delimiter regex for the custom pattern. + must_match: + type: + - array + - 'null' + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: + - array + - 'null' + description: List of regexes that the secret must not match. + 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: @@ -239411,6 +240110,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 @@ -258950,6 +259751,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. @@ -259788,6 +260623,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-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 155be35b24..d2cc995f1e 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -4873,15 +4873,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": [ { @@ -4911,21 +4911,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": [ { @@ -4961,21 +4964,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": [ { @@ -5008,21 +5014,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": [ { @@ -5055,21 +5064,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": [ { @@ -5099,21 +5111,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": [ { @@ -5149,8 +5164,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36338,6 +36356,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", @@ -72997,6 +73364,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", @@ -115247,7 +115975,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", @@ -134976,6 +135704,249 @@ ], "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." }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "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": { @@ -322570,6 +323541,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", @@ -345076,6 +346188,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.", @@ -346165,6 +347318,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-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index da74cfe6ab..8a443565c6 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -3707,15 +3707,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: @@ -3734,19 +3738,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" @@ -3767,18 +3776,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: @@ -3799,18 +3814,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" @@ -3830,18 +3851,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: @@ -3860,18 +3887,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" @@ -3892,6 +3925,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 @@ -26738,6 +26774,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 @@ -53378,6 +53653,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 @@ -83592,7 +84110,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 @@ -98386,6 +98904,187 @@ components: 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. + 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 + - 'null' + description: The start delimiter regex for the custom pattern. + end_delimiter: + type: + - string + - 'null' + description: The end delimiter regex for the custom pattern. + must_match: + type: + - array + - 'null' + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: + - array + - 'null' + description: List of regexes that the secret must not match. + 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: @@ -238698,6 +239397,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 @@ -258145,6 +258946,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. @@ -258983,6 +259818,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index b788bdba4a..2f26cedfb3 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -4887,15 +4887,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": [ { @@ -4925,21 +4925,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": [ { @@ -4975,21 +4978,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": [ { @@ -5022,21 +5028,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": [ { @@ -5069,21 +5078,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": [ { @@ -5113,21 +5125,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": [ { @@ -5163,8 +5178,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -36570,6 +36588,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", @@ -73393,6 +73760,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", @@ -115891,7 +116619,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", @@ -136447,6 +137175,249 @@ ], "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." }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "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": { @@ -325407,6 +326378,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", @@ -348175,6 +349287,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.", @@ -349264,6 +350417,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-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 2cd69324be..d7b0c8b6b6 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -3715,15 +3715,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: @@ -3742,19 +3746,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" @@ -3775,18 +3784,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: @@ -3807,18 +3822,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" @@ -3838,18 +3859,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: @@ -3868,18 +3895,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" @@ -3900,6 +3933,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 @@ -26870,6 +26906,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 @@ -53641,6 +53916,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 @@ -84013,7 +84531,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,187 @@ components: 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. + 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 + - 'null' + description: The start delimiter regex for the custom pattern. + end_delimiter: + type: + - string + - 'null' + description: The end delimiter regex for the custom pattern. + must_match: + type: + - array + - 'null' + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: + - array + - 'null' + description: List of regexes that the secret must not match. + 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: @@ -240682,6 +241381,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 @@ -260303,6 +261104,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. @@ -261141,6 +261976,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index e12328fab4..c0cf820f34 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -8623,7 +8623,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", @@ -9772,7 +9772,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", @@ -10694,7 +10694,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", @@ -11181,7 +11181,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", @@ -13545,7 +13545,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", @@ -14726,7 +14726,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", @@ -15771,7 +15771,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", @@ -16519,7 +16519,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", @@ -17992,15 +17992,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": [ { @@ -18401,21 +18401,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": [ { @@ -18860,21 +18863,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": [ { @@ -19023,21 +19029,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": [ { @@ -19125,21 +19134,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": [ { @@ -19305,21 +19317,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": [ { @@ -19593,8 +19608,11 @@ "x-github": { "enabledForGitHubApps": true, "category": "classroom", - "subcategory": "classroom" - } + "subcategory": "classroom", + "deprecationDate": "2026-05-22", + "removalDate": "2026-08-28" + }, + "deprecated": true } }, "/codes_of_conduct": { @@ -170209,7 +170227,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", @@ -171373,7 +171391,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", @@ -257136,23 +257154,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": [ { @@ -257163,6 +257181,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": { @@ -257171,210 +257262,1610 @@ "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", - "null" - ], - "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." - }, - "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", - "null" - ], - "description": "The version of this pattern if it's a custom pattern." - }, - "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", - "null" - ], - "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", - null - ] - }, - "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "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", - "null" - ], - "description": "The version of this pattern if it's a custom pattern." - }, - "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", - "null" - ], - "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", - null - ] - }, - "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", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "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." + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "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." + } + } + }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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", + "null" + ], + "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." + }, + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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", + "null" + ], + "description": "The version of this pattern if it's a custom pattern." + }, + "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", + "null" + ], + "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", + null + ] + }, + "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" + } + ] + } } } } @@ -446080,7 +447571,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", @@ -683089,6 +684580,1515 @@ } } }, + "/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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "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." + } + } + } + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ], + "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." + } + } + }, + "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", + "null" + ], + "description": "The start delimiter regex for the custom pattern." + }, + "end_delimiter": { + "type": [ + "string", + "null" + ], + "description": "The end delimiter regex for the custom pattern." + }, + "must_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must match.", + "items": { + "type": "string" + } + }, + "must_not_match": { + "type": [ + "array", + "null" + ], + "description": "List of regexes that the secret must not match.", + "items": { + "type": "string" + } + }, + "custom_pattern_version": { + "type": [ + "string", + "null" + ], + "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." + }, + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { "post": { "summary": "Create a push protection bypass", @@ -760067,7 +763067,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", @@ -857821,7 +860821,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", @@ -1089601,7 +1092601,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", @@ -1092741,7 +1095741,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", @@ -1095786,7 +1098786,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", @@ -1098831,7 +1101831,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", @@ -1102010,7 +1105010,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", @@ -1105196,7 +1108196,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", @@ -1110393,7 +1113393,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index c134db97e8..92428ded10 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -914,7 +914,7 @@ paths: - subscriptions_url - type - url - type: &329 + type: &331 type: string description: The type of credit the user is receiving. enum: @@ -1080,7 +1080,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &670 + - &685 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -4876,7 +4876,8 @@ paths: permissions: &22 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 @@ -6946,15 +6947,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: - &29 name: assignment_id @@ -7239,19 +7244,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: - *29 - *19 @@ -7536,18 +7546,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: - *29 responses: @@ -7637,18 +7653,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 @@ -7671,18 +7693,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: - &33 name: classroom_id @@ -7716,18 +7744,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: - *33 - *19 @@ -7769,6 +7803,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 @@ -12392,7 +12429,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 - - &486 + - &488 name: has in: query description: |- @@ -12522,7 +12559,7 @@ paths: - transitive - inconclusive - - security_advisory: &487 + security_advisory: &489 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12797,7 +12834,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &488 + auto_dismissed_at: &490 type: - string - 'null' @@ -12805,7 +12842,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissal_request: &489 + dismissal_request: &491 title: Dependabot alert dismissal request description: Information about an active dismissal request for this Dependabot alert. @@ -14524,7 +14561,7 @@ paths: properties: action: type: string - discussion: &763 + discussion: &778 title: Discussion description: A Discussion in a repository. type: object @@ -15310,7 +15347,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &681 + sub_issues_summary: &696 title: Sub-issues Summary type: object properties: @@ -15394,7 +15431,7 @@ paths: pin: anyOf: - type: 'null' - - &563 + - &565 title: Pinned Issue Comment description: Context around who pinned an issue comment and when it was pinned. @@ -15415,7 +15452,7 @@ paths: minimized: anyOf: - type: 'null' - - &564 + - &566 title: Minimized Issue Comment description: Details about why an issue comment was minimized. @@ -15440,7 +15477,7 @@ paths: - url - created_at - updated_at - issue_dependencies_summary: &682 + issue_dependencies_summary: &697 title: Issue Dependencies Summary type: object properties: @@ -15459,7 +15496,7 @@ paths: - total_blocking issue_field_values: type: array - items: &547 + items: &549 title: Issue Field Value description: A value assigned to an issue field type: object @@ -16276,7 +16313,7 @@ paths: type: string release: allOf: - - &607 + - &609 title: Release description: A release. type: object @@ -16358,7 +16395,7 @@ paths: author: *4 assets: type: array - items: &608 + items: &610 title: Release Asset description: Data related to a release. type: object @@ -16961,7 +16998,7 @@ paths: url: type: string format: uri - user: &690 + user: &705 title: Public User description: Public User type: object @@ -20326,14 +20363,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &337 + - &339 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &338 + - &340 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -20395,7 +20432,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &341 + '301': &343 description: Moved permanently content: application/json: @@ -20417,7 +20454,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &583 + - &585 name: all description: If `true`, show notifications marked as read. in: query @@ -20425,7 +20462,7 @@ paths: schema: type: boolean default: false - - &584 + - &586 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -20435,7 +20472,7 @@ paths: type: boolean default: false - *87 - - &585 + - &587 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: @@ -21028,7 +21065,7 @@ paths: - url - subscription_url examples: - default: &586 + default: &588 value: - id: '1' repository: @@ -22981,7 +23018,7 @@ paths: parameters: - *74 - *116 - - &741 + - &756 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 @@ -23093,7 +23130,7 @@ paths: - *116 - *117 - *118 - - &742 + - &757 name: repository description: The repository name to query for usage in the format owner/repository. in: query @@ -23101,7 +23138,7 @@ paths: schema: type: string - *121 - - &743 + - &758 name: sku description: The SKU to query for usage. in: query @@ -24080,7 +24117,7 @@ paths: type: integer repository_cache_usages: type: array - items: &348 + items: &350 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -25468,7 +25505,7 @@ paths: - all - local_only - selected - selected_actions_url: &353 + selected_actions_url: &355 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` @@ -25551,7 +25588,7 @@ paths: description: Response content: application/json: - schema: &357 + schema: &359 type: object properties: days: @@ -25593,7 +25630,7 @@ paths: required: true content: application/json: - schema: &358 + schema: &360 type: object properties: days: @@ -25650,7 +25687,7 @@ paths: required: - approval_policy examples: - default: &359 + default: &361 value: approval_policy: first_time_contributors '404': *6 @@ -25709,7 +25746,7 @@ paths: description: Response content: application/json: - schema: &360 + schema: &362 type: object required: - run_workflows_from_fork_pull_requests @@ -25763,7 +25800,7 @@ paths: required: true content: application/json: - schema: &361 + schema: &363 type: object required: - run_workflows_from_fork_pull_requests @@ -26398,7 +26435,7 @@ paths: description: Response content: application/json: - schema: &362 + schema: &364 type: object properties: default_workflow_permissions: &148 @@ -26449,7 +26486,7 @@ paths: required: false content: application/json: - schema: &363 + schema: &365 type: object properties: default_workflow_permissions: *148 @@ -27600,7 +27637,7 @@ paths: application/json: schema: type: array - items: &364 + items: &366 title: Runner Application description: Runner Application type: object @@ -27625,7 +27662,7 @@ paths: - download_url - filename examples: - default: &365 + default: &367 value: - os: osx architecture: x64 @@ -27711,7 +27748,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &366 + '201': &368 description: Response content: application/json: @@ -27826,7 +27863,7 @@ paths: - token - expires_at examples: - default: &367 + default: &369 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -27865,7 +27902,7 @@ paths: application/json: schema: *159 examples: - default: &368 + default: &370 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -27899,7 +27936,7 @@ paths: application/json: schema: *157 examples: - default: &369 + default: &371 value: id: 23 name: MBP @@ -28126,7 +28163,7 @@ paths: - *74 - *156 responses: - '200': &370 + '200': &372 description: Response content: application/json: @@ -28183,7 +28220,7 @@ paths: parameters: - *74 - *156 - - &371 + - &373 name: name description: The name of a self-hosted runner's custom label. in: path @@ -30785,12 +30822,12 @@ paths: required: - subject_digests examples: - default: &722 + default: &737 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &723 + withPredicateType: &738 value: subject_digests: - sha256:abc123 @@ -30849,7 +30886,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &724 + default: &739 value: attestations_subject_digests: - sha256:abc: @@ -31200,7 +31237,7 @@ paths: initiator: type: string examples: - default: &397 + default: &399 value: attestations: - bundle: @@ -32168,7 +32205,7 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *74 - - &423 + - &425 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`, @@ -32178,7 +32215,7 @@ paths: schema: &187 type: string description: The name of the tool used to generate the code scanning analysis. - - &424 + - &426 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 @@ -32202,7 +32239,7 @@ paths: be returned. in: query required: false - schema: &426 + schema: &428 type: string description: State of a code scanning alert. enum: @@ -32225,7 +32262,7 @@ paths: be returned. in: query required: false - schema: &427 + schema: &429 type: string description: Severity of a code scanning alert. enum: @@ -32259,7 +32296,7 @@ paths: updated_at: *182 url: *183 html_url: *184 - instances_url: &428 + instances_url: &430 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -32281,7 +32318,7 @@ paths: - type: 'null' - *4 dismissed_at: *186 - dismissed_reason: &429 + dismissed_reason: &431 type: - string - 'null' @@ -32292,14 +32329,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &430 + dismissed_comment: &432 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &431 + rule: &433 type: object properties: id: @@ -32360,7 +32397,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &432 + tool: &434 type: object properties: name: *187 @@ -32371,26 +32408,26 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *188 - most_recent_instance: &433 + most_recent_instance: &435 type: object properties: - ref: &425 + ref: &427 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &443 + analysis_key: &445 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: &444 + environment: &446 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: &445 + category: &447 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -32410,7 +32447,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: &446 + location: &448 type: object description: Describe a region within a file for the alert. properties: @@ -32431,7 +32468,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: &447 + items: &449 type: - string - 'null' @@ -33766,7 +33803,7 @@ paths: machine: anyOf: - type: 'null' - - &459 + - &461 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -34718,7 +34755,7 @@ paths: - updated_at - visibility examples: - default: &460 + default: &462 value: total_count: 2 secrets: @@ -34756,7 +34793,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &463 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -34791,7 +34828,7 @@ paths: - key_id - key examples: - default: &462 + default: &464 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34823,7 +34860,7 @@ paths: application/json: schema: *195 examples: - default: &464 + default: &466 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -38385,7 +38422,7 @@ paths: description: Response content: application/json: - schema: &492 + schema: &494 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -38404,7 +38441,7 @@ paths: - key_id - key examples: - default: &493 + default: &495 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40230,7 +40267,7 @@ paths: application/json: schema: *20 examples: - default: &530 + default: &532 value: id: 1 account: @@ -40458,7 +40495,7 @@ paths: required: true content: application/json: - schema: &531 + schema: &533 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration @@ -41277,7 +41314,7 @@ paths: type: array items: *245 examples: - default: &535 + default: &537 value: - id: 410 node_id: IT_kwDNAd3NAZo @@ -41806,7 +41843,7 @@ paths: application/json: schema: *250 examples: - default: &458 + default: &460 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -43068,7 +43105,7 @@ paths: parameters: - *74 - *257 - - &705 + - &720 name: repo_name description: repo_name parameter in: path @@ -44129,7 +44166,7 @@ paths: - nuget - container - *74 - - &706 + - &721 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -44170,7 +44207,7 @@ paths: default: *263 '403': *27 '401': *23 - '400': &708 + '400': &723 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -46301,7 +46338,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &791 + - &806 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -46575,7 +46612,7 @@ paths: content: oneOf: - *82 - - &473 + - &475 title: Pull Request Simple description: Pull Request Simple type: object @@ -46814,7 +46851,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: &593 + auto_merge: &595 title: Auto merge description: The status of auto merging a pull request. type: @@ -47199,7 +47236,7 @@ paths: - updated_at - project_url examples: - default: &728 + default: &743 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47376,7 +47413,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: &729 + items: &744 type: object properties: name: @@ -47413,7 +47450,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: &730 + iteration_configuration: &745 type: object description: The configuration for iteration fields. properties: @@ -47463,7 +47500,7 @@ paths: value: name: Due date data_type: date - single_select_field: &731 + single_select_field: &746 summary: Create a single select field value: name: Priority @@ -47490,7 +47527,7 @@ paths: description: raw: High priority items html: High priority items - iteration_field: &732 + iteration_field: &747 summary: Create an iteration field value: name: Sprint @@ -47516,7 +47553,7 @@ paths: application/json: schema: *283 examples: - text_field: &733 + text_field: &748 value: id: 24680 node_id: PVTF_lADOABCD2468024680 @@ -47525,7 +47562,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: &734 + number_field: &749 value: id: 13579 node_id: PVTF_lADOABCD1357913579 @@ -47534,7 +47571,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: &735 + date_field: &750 value: id: 98765 node_id: PVTF_lADOABCD9876598765 @@ -47543,7 +47580,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: &736 + single_select_field: &751 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -47577,7 +47614,7 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - iteration_field: &737 + iteration_field: &752 value: id: 11223 node_id: PVTF_lADOABCD1122311223 @@ -47623,7 +47660,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *280 - - &738 + - &753 name: field_id description: The unique identifier of the field. in: path @@ -47638,7 +47675,7 @@ paths: application/json: schema: *283 examples: - default: &739 + default: &754 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -48849,7 +48886,7 @@ paths: description: Response for creating a view in an organization-owned project. content: application/json: - schema: &719 + schema: &734 title: Projects v2 View description: A view inside a projects v2 project type: object @@ -49032,7 +49069,7 @@ paths: parameters: - *280 - *74 - - &740 + - &755 name: view_number description: The number that identifies the project view. in: path @@ -49995,7 +50032,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &342 title: Full Repository description: Full Repository type: object @@ -50473,7 +50510,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &478 + code_of_conduct: &480 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -50587,7 +50624,7 @@ paths: - network_count - subscribers_count examples: - default: &342 + default: &344 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -51108,7 +51145,7 @@ paths: - *74 - *17 - *19 - - &616 + - &618 name: targets description: | A comma-separated list of rule targets to filter by. @@ -51395,7 +51432,7 @@ paths: - object rules: type: array - items: &617 + items: &619 title: Repository Rule type: object description: A repository rule. @@ -51457,7 +51494,7 @@ paths: type: string enum: - required_linear_history - - &614 + - &616 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -52096,7 +52133,7 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. - - &615 + - &617 title: license_compliance_scanning description: Enforce any added or changed dependencies to comply with the organization's license policy. @@ -52408,7 +52445,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *74 - - &618 + - &620 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 @@ -52423,7 +52460,7 @@ paths: in: query schema: type: string - - &619 + - &621 name: time_period description: |- The time period to filter by. @@ -52439,14 +52476,14 @@ paths: - week - month default: day - - &620 + - &622 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 - - &621 + - &623 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -52459,7 +52496,7 @@ paths: - bypass - all default: all - - &622 + - &624 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. @@ -52482,7 +52519,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &625 title: Rule Suites description: Response type: array @@ -52538,7 +52575,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &624 + default: &626 value: - id: 21 actor_id: 12 @@ -52582,7 +52619,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *74 - - &625 + - &627 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -52598,7 +52635,7 @@ paths: description: Response content: application/json: - schema: &626 + schema: &628 title: Rule Suite description: Response type: object @@ -52705,7 +52742,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &627 + default: &629 value: id: 21 actor_id: 12 @@ -52952,7 +52989,7 @@ paths: type: string format: date-time examples: - default: &629 + default: &631 value: - version_id: 3 actor: @@ -53005,7 +53042,7 @@ paths: description: Response content: application/json: - schema: &630 + schema: &632 allOf: - *326 - type: object @@ -53077,7 +53114,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *74 - - &631 + - &633 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -53088,7 +53125,7 @@ paths: enum: - open - resolved - - &632 + - &634 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -53098,7 +53135,7 @@ paths: required: false schema: type: string - - &633 + - &635 name: exclude_secret_types in: query description: A comma-separated list of secret types to exclude from the results. @@ -53109,7 +53146,7 @@ paths: required: false schema: type: string - - &634 + - &636 name: exclude_providers in: query description: |- @@ -53120,7 +53157,7 @@ paths: required: false schema: type: string - - &635 + - &637 name: providers in: query description: |- @@ -53131,7 +53168,7 @@ paths: required: false schema: type: string - - &636 + - &638 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -53140,7 +53177,7 @@ paths: required: false schema: type: string - - &637 + - &639 name: assignee in: query description: Filters alerts by assignee. Use `*` to get all assigned alerts, @@ -53159,7 +53196,7 @@ paths: all-unassigned: value: none summary: Filter for all unassigned alerts - - &638 + - &640 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. @@ -53174,7 +53211,7 @@ paths: - *60 - *19 - *17 - - &639 + - &641 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 @@ -53184,7 +53221,7 @@ paths: required: false schema: type: string - - &640 + - &642 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 @@ -53194,7 +53231,7 @@ paths: required: false schema: type: string - - &641 + - &643 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -53203,7 +53240,7 @@ paths: required: false schema: type: string - - &642 + - &644 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -53212,7 +53249,7 @@ paths: schema: type: boolean default: false - - &643 + - &645 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -53221,7 +53258,7 @@ paths: schema: type: boolean default: false - - &644 + - &646 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -53230,7 +53267,7 @@ paths: schema: type: boolean default: false - - &645 + - &647 name: is_bypassed in: query description: A boolean value (`true` or `false`) indicating whether to filter @@ -53241,7 +53278,7 @@ paths: required: false schema: type: boolean - - &646 + - &648 name: included_metadata in: query description: |- @@ -53252,7 +53289,7 @@ paths: required: false schema: type: string - - &647 + - &649 name: owner_email_hash in: query description: |- @@ -53287,14 +53324,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &648 + state: &650 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: &649 + resolution: &651 type: - string - 'null' @@ -53413,14 +53450,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &650 + - &652 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &652 + - &654 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -53484,7 +53521,7 @@ paths: - blob_url - commit_sha - commit_url - - &653 + - &655 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. @@ -53545,7 +53582,7 @@ paths: - page_url - commit_sha - commit_url - - &654 + - &656 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -53567,7 +53604,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_title_url - - &655 + - &657 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -53589,7 +53626,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1 required: - issue_body_url - - &656 + - &658 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -53611,7 +53648,7 @@ paths: - https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 required: - issue_comment_url - - &657 + - &659 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -53626,7 +53663,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &658 + - &660 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -53641,7 +53678,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &659 + - &661 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -53656,7 +53693,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &660 + - &662 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. @@ -53678,7 +53715,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_title_url - - &661 + - &663 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. @@ -53700,7 +53737,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846 required: - pull_request_body_url - - &662 + - &664 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. @@ -53722,7 +53759,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 required: - pull_request_comment_url - - &663 + - &665 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. @@ -53744,7 +53781,7 @@ paths: - https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 required: - pull_request_review_url - - &664 + - &666 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 @@ -53974,6 +54011,531 @@ 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: + - *74 + - &667 + 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 + - &668 + 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 + - &669 + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + - *60 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &327 + 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 + - 'null' + description: The start delimiter regex for the custom pattern. + end_delimiter: + type: + - string + - 'null' + description: The end delimiter regex for the custom pattern. + must_match: + type: + - array + - 'null' + description: List of regexes that the secret must match. + items: + type: string + must_not_match: + type: + - array + - 'null' + description: List of regexes that the secret must not match. + items: + type: string + custom_pattern_version: &328 + type: + - string + - 'null' + 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. + 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: &670 + 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: *66 + '403': *27 + '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: + - *74 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: &671 + 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: &672 + 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: *327 + examples: + default: &673 + 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': *27 + '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: &674 + 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: + - *74 + 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: &675 + 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: *328 + 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: &676 + value: + patterns: + - pattern_id: 2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *27 + '404': *6 + '412': &329 + 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: + - *74 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: &677 + 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: *328 + examples: + default: &678 + 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: *327 + examples: + default: &679 + 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': *27 + '404': *6 + '412': *329 + '422': *15 "/orgs/{org}/secret-scanning/pattern-configurations": get: summary: List organization pattern configurations @@ -54005,17 +54567,11 @@ paths: related to push protection. type: object properties: - pattern_config_version: &328 - type: - - string - - 'null' - 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. + pattern_config_version: *328 provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &327 + items: &330 type: object properties: token_type: @@ -54084,7 +54640,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *327 + items: *330 examples: default: value: @@ -54265,7 +54821,7 @@ paths: application/json: schema: type: array - items: &668 + items: &683 description: A repository security advisory. type: object properties: @@ -54509,7 +55065,7 @@ paths: login: type: string description: The username of the user credited. - type: *329 + type: *331 credits_detailed: type: - array @@ -54520,7 +55076,7 @@ paths: type: object properties: user: *4 - type: *329 + type: *331 state: type: string description: The state of the user's acceptance of the @@ -54584,7 +55140,7 @@ paths: - private_fork additionalProperties: false examples: - default: &669 + default: &684 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55326,7 +55882,7 @@ paths: type: integer network_configurations: type: array - items: &330 + items: &332 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -55479,9 +56035,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *332 examples: - default: &331 + default: &333 value: id: 123456789ABCDEF name: My network configuration @@ -55510,7 +56066,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - &332 + - &334 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -55522,9 +56078,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *332 examples: - default: *331 + default: *333 headers: Link: *66 x-github: @@ -55546,7 +56102,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - *74 - - *332 + - *334 requestBody: required: true content: @@ -55599,9 +56155,9 @@ paths: description: Response content: application/json: - schema: *330 + schema: *332 examples: - default: *331 + default: *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55621,7 +56177,7 @@ paths: url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - *74 - - *332 + - *334 responses: '204': description: Response @@ -55839,7 +56395,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &335 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56238,7 +56794,7 @@ paths: - repos_count - organization examples: - default: &334 + default: &336 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56315,9 +56871,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '404': *6 x-github: githubCloudOnly: false @@ -56402,16 +56958,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '201': description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '404': *6 '422': *15 '403': *27 @@ -56441,7 +56997,7 @@ paths: responses: '204': description: Response - '422': &335 + '422': &337 description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. x-github: @@ -56480,7 +57036,7 @@ paths: default: *240 headers: Link: *66 - '422': *335 + '422': *337 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56524,7 +57080,7 @@ paths: application/json: schema: type: array - items: &684 + items: &699 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 @@ -56667,7 +57223,7 @@ paths: - type - url examples: - default: &685 + default: &700 value: - login: octocat id: 1 @@ -56726,7 +57282,7 @@ paths: description: Response content: application/json: - schema: &336 + schema: &338 title: Team Membership description: Team Membership type: object @@ -56754,7 +57310,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &686 + response-if-user-is-a-team-maintainer: &701 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -56817,9 +57373,9 @@ paths: description: Response content: application/json: - schema: *336 + schema: *338 examples: - response-if-users-membership-with-team-is-now-pending: &687 + response-if-users-membership-with-team-is-now-pending: &702 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -56926,14 +57482,14 @@ paths: parameters: - *74 - *76 - - *337 - - *338 + - *339 + - *340 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &688 + schema: &703 title: Team Repository description: A team's access to a repository. type: object @@ -57576,8 +58132,8 @@ paths: parameters: - *74 - *76 - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -57624,8 +58180,8 @@ paths: parameters: - *74 - *76 - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -57662,7 +58218,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: &689 + response-if-child-teams-exist: &704 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -57815,7 +58371,7 @@ paths: resources: type: object properties: - core: &339 + core: &341 title: Rate Limit type: object properties: @@ -57832,21 +58388,21 @@ paths: - remaining - reset - used - graphql: *339 - search: *339 - code_search: *339 - source_import: *339 - integration_manifest: *339 - actions_runner_registration: *339 - scim: *339 - dependency_snapshots: *339 - dependency_sbom: *339 - code_scanning_autofix: *339 - copilot_usage_records: *339 + graphql: *341 + search: *341 + code_search: *341 + source_import: *341 + integration_manifest: *341 + actions_runner_registration: *341 + scim: *341 + dependency_snapshots: *341 + dependency_sbom: *341 + code_scanning_autofix: *341 + copilot_usage_records: *341 required: - core - search - rate: *339 + rate: *341 required: - rate - resources @@ -57946,14 +58502,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *340 + schema: *342 examples: default-response: summary: Default response @@ -58458,7 +59014,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *341 + '301': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58476,8 +59032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -58788,10 +59344,10 @@ paths: description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *342 - '307': &343 + default: *344 + '307': &345 description: Temporary Redirect content: application/json: @@ -58820,8 +59376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -58843,7 +59399,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *343 + '307': *345 '404': *6 '409': *52 x-github: @@ -58867,11 +59423,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 - - &375 + - &377 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -58894,7 +59450,7 @@ paths: type: integer artifacts: type: array - items: &344 + items: &346 title: Artifact description: An artifact type: object @@ -58989,7 +59545,7 @@ paths: - expires_at - updated_at examples: - default: &376 + default: &378 value: total_count: 2 artifacts: @@ -59050,9 +59606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *337 - - *338 - - &345 + - *339 + - *340 + - &347 name: artifact_id description: The unique identifier of the artifact. in: path @@ -59064,7 +59620,7 @@ paths: description: Response content: application/json: - schema: *344 + schema: *346 examples: default: value: @@ -59102,9 +59658,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *337 - - *338 - - *345 + - *339 + - *340 + - *347 responses: '204': description: Response @@ -59128,9 +59684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *337 - - *338 - - *345 + - *339 + - *340 + - *347 - name: archive_format in: path required: true @@ -59140,11 +59696,11 @@ paths: '302': description: Response headers: - Location: &495 + Location: &497 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': &536 + '410': &538 description: Gone content: application/json: @@ -59169,14 +59725,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: &346 + schema: &348 title: Actions cache retention limit for a repository description: GitHub Actions cache retention policy for a repository. type: object @@ -59210,13 +59766,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *346 + schema: *348 examples: selected_actions: *40 responses: @@ -59245,14 +59801,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: &347 + schema: &349 title: Actions cache storage limit for a repository description: GitHub Actions cache storage policy for a repository. type: object @@ -59286,13 +59842,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *347 + schema: *349 examples: selected_actions: *42 responses: @@ -59323,14 +59879,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *348 + schema: *350 examples: default: value: @@ -59356,11 +59912,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 - - &349 + - &351 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 @@ -59394,7 +59950,7 @@ paths: description: Response content: application/json: - schema: &350 + schema: &352 title: Repository actions caches description: Repository actions caches type: object @@ -59444,7 +60000,7 @@ paths: - total_count - actions_caches examples: - default: &351 + default: &353 value: total_count: 1 actions_caches: @@ -59476,23 +60032,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: - - *337 - - *338 + - *339 + - *340 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *349 + - *351 responses: '200': description: Response content: application/json: - schema: *350 + schema: *352 examples: - default: *351 + default: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59512,8 +60068,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: - - *337 - - *338 + - *339 + - *340 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -59542,8 +60098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *46 responses: @@ -59626,8 +60182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - name: concurrency_group_name description: The name of the concurrency group. in: path @@ -59783,9 +60339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *337 - - *338 - - &352 + - *339 + - *340 + - &354 name: job_id description: The unique identifier of the job. in: path @@ -59797,7 +60353,7 @@ paths: description: Response content: application/json: - schema: &379 + schema: &381 title: Job description: Information of a job execution in a workflow run type: object @@ -60144,9 +60700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *337 - - *338 - - *352 + - *339 + - *340 + - *354 responses: '302': description: Response @@ -60174,9 +60730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *337 - - *338 - - *352 + - *339 + - *340 + - *354 requestBody: required: false content: @@ -60227,8 +60783,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Status response @@ -60287,8 +60843,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -60356,8 +60912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -60375,7 +60931,7 @@ paths: type: integer secrets: type: array - items: &381 + items: &383 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -60396,7 +60952,7 @@ paths: - created_at - updated_at examples: - default: &382 + default: &384 value: total_count: 2 secrets: @@ -60429,8 +60985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *337 - - *338 + - *339 + - *340 - *172 - *19 responses: @@ -60448,7 +61004,7 @@ paths: type: integer variables: type: array - items: &383 + items: &385 title: Actions Variable type: object properties: @@ -60482,7 +61038,7 @@ paths: - created_at - updated_at examples: - default: &384 + default: &386 value: total_count: 2 variables: @@ -60515,8 +61071,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -60525,11 +61081,11 @@ paths: schema: type: object properties: - enabled: &354 + enabled: &356 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *140 - selected_actions_url: *353 + selected_actions_url: *355 sha_pinning_required: *141 required: - enabled @@ -60558,8 +61114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -60570,7 +61126,7 @@ paths: schema: type: object properties: - enabled: *354 + enabled: *356 allowed_actions: *140 sha_pinning_required: *141 required: @@ -60602,14 +61158,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: &355 + schema: &357 type: object properties: access_level: @@ -60626,7 +61182,7 @@ paths: required: - access_level examples: - default: &356 + default: &358 value: access_level: organization x-github: @@ -60650,15 +61206,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *355 + schema: *357 examples: - default: *356 + default: *358 responses: '204': description: Response @@ -60682,14 +61238,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *357 + schema: *359 examples: default: value: @@ -60713,8 +61269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Empty response for successful settings update @@ -60724,7 +61280,7 @@ paths: required: true content: application/json: - schema: *358 + schema: *360 examples: default: summary: Set retention days @@ -60748,8 +61304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -60757,7 +61313,7 @@ paths: application/json: schema: *142 examples: - default: *359 + default: *361 '404': *6 x-github: enabledForGitHubApps: true @@ -60776,8 +61332,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -60811,14 +61367,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *360 + schema: *362 examples: default: *143 '403': *27 @@ -60840,13 +61396,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *361 + schema: *363 examples: default: *143 responses: @@ -60872,8 +61428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -60900,8 +61456,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -60933,14 +61489,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *362 + schema: *364 examples: default: *150 x-github: @@ -60963,8 +61519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Success response @@ -60975,7 +61531,7 @@ paths: required: true content: application/json: - schema: *363 + schema: *365 examples: default: *150 x-github: @@ -61004,8 +61560,8 @@ paths: in: query schema: type: string - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -61049,8 +61605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -61058,9 +61614,9 @@ paths: application/json: schema: type: array - items: *364 + items: *366 examples: - default: *365 + default: *367 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61082,8 +61638,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -61126,7 +61682,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *366 + '201': *368 '404': *6 '422': *7 '409': *52 @@ -61157,8 +61713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '201': description: Response @@ -61166,7 +61722,7 @@ paths: application/json: schema: *159 examples: - default: *367 + default: *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61194,8 +61750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '201': description: Response @@ -61203,7 +61759,7 @@ paths: application/json: schema: *159 examples: - default: *368 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61225,8 +61781,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: - - *337 - - *338 + - *339 + - *340 - *156 responses: '200': @@ -61235,7 +61791,7 @@ paths: application/json: schema: *157 examples: - default: *369 + default: *371 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61256,8 +61812,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: - - *337 - - *338 + - *339 + - *340 - *156 responses: '204': @@ -61284,8 +61840,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: - - *337 - - *338 + - *339 + - *340 - *156 responses: '200': *161 @@ -61310,8 +61866,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: - - *337 - - *338 + - *339 + - *340 - *156 requestBody: required: true @@ -61360,8 +61916,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: - - *337 - - *338 + - *339 + - *340 - *156 requestBody: required: true @@ -61411,11 +61967,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: - - *337 - - *338 + - *339 + - *340 - *156 responses: - '200': *370 + '200': *372 '404': *6 x-github: githubCloudOnly: false @@ -61442,10 +61998,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: - - *337 - - *338 + - *339 + - *340 - *156 - - *371 + - *373 responses: '200': *161 '404': *6 @@ -61473,9 +62029,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *337 - - *338 - - &387 + - *339 + - *340 + - &389 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. @@ -61483,7 +62039,7 @@ paths: required: false schema: type: string - - &388 + - &390 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -61491,7 +62047,7 @@ paths: required: false schema: type: string - - &389 + - &391 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -61500,7 +62056,7 @@ paths: required: false schema: type: string - - &390 + - &392 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 @@ -61527,7 +62083,7 @@ paths: - pending - *17 - *19 - - &391 + - &393 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)." @@ -61536,7 +62092,7 @@ paths: schema: type: string format: date-time - - &372 + - &374 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -61545,13 +62101,13 @@ paths: schema: type: boolean default: false - - &392 + - &394 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &393 + - &395 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -61574,7 +62130,7 @@ paths: type: integer workflow_runs: type: array - items: &373 + items: &375 title: Workflow Run description: An invocation of a workflow type: object @@ -61752,7 +62308,7 @@ paths: head_commit: anyOf: - type: 'null' - - &417 + - &419 title: Simple Commit description: A commit. type: object @@ -61867,7 +62423,7 @@ paths: - workflow_url - pull_requests examples: - default: &394 + default: &396 value: total_count: 1 workflow_runs: @@ -62103,24 +62659,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *337 - - *338 - - &374 + - *339 + - *340 + - &376 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *372 + - *374 responses: '200': description: Response content: application/json: - schema: *373 + schema: *375 examples: - default: &377 + default: &379 value: id: 30433642 name: Build @@ -62361,9 +62917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '204': description: Response @@ -62386,9 +62942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '200': description: Response @@ -62516,9 +63072,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: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '201': description: Response @@ -62551,12 +63107,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 - *17 - *19 - - *375 + - *377 - *60 responses: '200': @@ -62573,9 +63129,9 @@ paths: type: integer artifacts: type: array - items: *344 + items: *346 examples: - default: *376 + default: *378 headers: Link: *66 x-github: @@ -62599,25 +63155,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *337 - - *338 - - *374 - - &378 + - *339 + - *340 + - *376 + - &380 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *372 + - *374 responses: '200': description: Response content: application/json: - schema: *373 + schema: *375 examples: - default: *377 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62640,10 +63196,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *337 - - *338 - - *374 - - *378 + - *339 + - *340 + - *376 + - *380 - *17 - *19 responses: @@ -62661,9 +63217,9 @@ paths: type: integer jobs: type: array - items: *379 + items: *381 examples: - default: &380 + default: &382 value: total_count: 1 jobs: @@ -62776,10 +63332,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *337 - - *338 - - *374 - - *378 + - *339 + - *340 + - *376 + - *380 responses: '302': description: Response @@ -62807,9 +63363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '202': description: Response @@ -62855,9 +63411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 - *17 - *45 - *46 @@ -63034,9 +63590,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: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 requestBody: required: true content: @@ -63103,9 +63659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '202': description: Response @@ -63138,9 +63694,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 - 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 @@ -63170,9 +63726,9 @@ paths: type: integer jobs: type: array - items: *379 + items: *381 examples: - default: *380 + default: *382 headers: Link: *66 x-github: @@ -63197,9 +63753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '302': description: Response @@ -63226,9 +63782,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '204': description: Response @@ -63255,9 +63811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '200': description: Response @@ -63326,7 +63882,7 @@ paths: items: type: object properties: - type: &502 + type: &504 type: string description: The type of reviewer. enum: @@ -63412,9 +63968,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 requestBody: required: true content: @@ -63464,7 +64020,7 @@ paths: application/json: schema: type: array - items: &497 + items: &499 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -63576,7 +64132,7 @@ paths: - created_at - updated_at examples: - default: &498 + default: &500 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -63632,9 +64188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 requestBody: required: false content: @@ -63679,9 +64235,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 requestBody: required: false content: @@ -63735,9 +64291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *337 - - *338 - - *374 + - *339 + - *340 + - *376 responses: '200': description: Response @@ -63874,8 +64430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -63893,9 +64449,9 @@ paths: type: integer secrets: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 headers: Link: *66 x-github: @@ -63920,8 +64476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -63951,17 +64507,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: - default: &395 + default: &397 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -63987,8 +64543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 requestBody: required: true @@ -64046,8 +64602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '204': @@ -64073,8 +64629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *337 - - *338 + - *339 + - *340 - *172 - *19 responses: @@ -64092,9 +64648,9 @@ paths: type: integer variables: type: array - items: *383 + items: *385 examples: - default: *384 + default: *386 headers: Link: *66 x-github: @@ -64117,8 +64673,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -64170,17 +64726,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 responses: '200': description: Response content: application/json: - schema: *383 + schema: *385 examples: - default: &396 + default: &398 value: name: USERNAME value: octocat @@ -64206,8 +64762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 requestBody: required: true @@ -64250,8 +64806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 responses: '204': @@ -64277,8 +64833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -64296,7 +64852,7 @@ paths: type: integer workflows: type: array - items: &385 + items: &387 title: Workflow description: A GitHub Actions workflow type: object @@ -64414,9 +64970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *337 - - *338 - - &386 + - *339 + - *340 + - &388 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -64431,7 +64987,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *387 examples: default: value: @@ -64464,9 +65020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *337 - - *338 - - *386 + - *339 + - *340 + - *388 responses: '204': description: Response @@ -64491,9 +65047,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *337 - - *338 - - *386 + - *339 + - *340 + - *388 responses: '204': description: Empty response when `return_run_details` parameter is `false`. @@ -64580,9 +65136,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *337 - - *338 - - *386 + - *339 + - *340 + - *388 responses: '204': description: Response @@ -64609,19 +65165,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *337 - - *338 - - *386 - - *387 + - *339 + - *340 - *388 - *389 - *390 - - *17 - - *19 - *391 - - *372 - *392 + - *17 + - *19 - *393 + - *374 + - *394 + - *395 responses: '200': description: Response @@ -64637,9 +65193,9 @@ paths: type: integer workflow_runs: type: array - items: *373 + items: *375 examples: - default: *394 + default: *396 headers: Link: *66 x-github: @@ -64671,9 +65227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *337 - - *338 - - *386 + - *339 + - *340 + - *388 responses: '200': description: Response @@ -64734,8 +65290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *337 - - *338 + - *339 + - *340 - *60 - *17 - *45 @@ -64908,8 +65464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-organization-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -64927,9 +65483,9 @@ paths: type: integer secrets: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 headers: Link: *66 x-github: @@ -64953,8 +65509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-organization-variables parameters: - - *337 - - *338 + - *339 + - *340 - *172 - *19 responses: @@ -64972,9 +65528,9 @@ paths: type: integer variables: type: array - items: *383 + items: *385 examples: - default: *384 + default: *386 headers: Link: *66 x-github: @@ -64999,8 +65555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#list-repository-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -65018,9 +65574,9 @@ paths: type: integer secrets: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 headers: Link: *66 x-github: @@ -65045,8 +65601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-public-key parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -65076,17 +65632,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#get-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: - default: *395 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65108,8 +65664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#create-or-update-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 requestBody: required: true @@ -65167,8 +65723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/secrets#delete-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '204': @@ -65194,8 +65750,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#list-repository-variables parameters: - - *337 - - *338 + - *339 + - *340 - *172 - *19 responses: @@ -65213,9 +65769,9 @@ paths: type: integer variables: type: array - items: *383 + items: *385 examples: - default: *384 + default: *386 headers: Link: *66 x-github: @@ -65238,8 +65794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#create-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -65291,17 +65847,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#get-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 responses: '200': description: Response content: application/json: - schema: *383 + schema: *385 examples: - default: *396 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65322,8 +65878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#update-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 requestBody: required: true @@ -65366,8 +65922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/agents/variables#delete-a-repository-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 responses: '204': @@ -65389,8 +65945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -65427,8 +65983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *337 - - *338 + - *339 + - *340 - name: assignee in: path required: true @@ -65464,8 +66020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -65575,8 +66131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *45 - *46 @@ -65633,7 +66189,7 @@ paths: initiator: type: string examples: - default: *397 + default: *399 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65653,8 +66209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -65662,7 +66218,7 @@ paths: application/json: schema: type: array - items: &398 + items: &400 title: Autolink reference description: An autolink reference. type: object @@ -65721,8 +66277,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -65761,9 +66317,9 @@ paths: description: response content: application/json: - schema: *398 + schema: *400 examples: - default: &399 + default: &401 value: id: 1 key_prefix: TICKET- @@ -65794,9 +66350,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *337 - - *338 - - &400 + - *339 + - *340 + - &402 name: autolink_id description: The unique identifier of the autolink. in: path @@ -65808,9 +66364,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *400 examples: - default: *399 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -65830,9 +66386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *337 - - *338 - - *400 + - *339 + - *340 + - *402 responses: '204': description: Response @@ -65856,8 +66412,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response if Dependabot is enabled @@ -65907,8 +66463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -65929,8 +66485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -65950,8 +66506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *337 - - *338 + - *339 + - *340 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -65989,7 +66545,7 @@ paths: - url protected: type: boolean - protection: &402 + protection: &404 title: Branch Protection description: Branch Protection type: object @@ -66032,7 +66588,7 @@ paths: required: - contexts - checks - enforce_admins: &405 + enforce_admins: &407 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -66049,7 +66605,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &407 + required_pull_request_reviews: &409 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -66133,7 +66689,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &404 + restrictions: &406 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -66426,9 +66982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *337 - - *338 - - &403 + - *339 + - *340 + - &405 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). @@ -66442,14 +66998,14 @@ paths: description: Response content: application/json: - schema: &413 + schema: &415 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &469 + commit: &471 title: Commit description: Commit type: object @@ -66488,7 +67044,7 @@ paths: author: anyOf: - type: 'null' - - &401 + - &403 title: Git User description: Metaproperties for Git author/committer information. @@ -66510,7 +67066,7 @@ paths: committer: anyOf: - type: 'null' - - *401 + - *403 message: type: string examples: @@ -66534,7 +67090,7 @@ paths: required: - sha - url - verification: &520 + verification: &522 title: Verification type: object properties: @@ -66614,7 +67170,7 @@ paths: type: integer files: type: array - items: &480 + items: &482 title: Diff Entry description: Diff Entry type: object @@ -66710,7 +67266,7 @@ paths: - self protected: type: boolean - protection: *402 + protection: *404 protection_url: type: string format: uri @@ -66819,7 +67375,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *341 + '301': *343 '404': *6 x-github: githubCloudOnly: false @@ -66841,15 +67397,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *402 + schema: *404 examples: default: value: @@ -67043,9 +67599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -67305,7 +67861,7 @@ paths: url: type: string format: uri - required_status_checks: &410 + required_status_checks: &412 title: Status Check Policy description: Status Check Policy type: object @@ -67464,7 +68020,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *404 + restrictions: *406 required_conversation_resolution: type: object properties: @@ -67576,9 +68132,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -67603,17 +68159,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *405 + schema: *407 examples: - default: &406 + default: &408 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -67635,17 +68191,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *405 + schema: *407 examples: - default: *406 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67664,9 +68220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -67691,17 +68247,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *407 + schema: *409 examples: - default: &408 + default: &410 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -67797,9 +68353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -67897,9 +68453,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *409 examples: - default: *408 + default: *410 '422': *15 x-github: githubCloudOnly: false @@ -67920,9 +68476,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -67949,17 +68505,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *405 + schema: *407 examples: - default: &409 + default: &411 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -67982,17 +68538,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *405 + schema: *407 examples: - default: *409 + default: *411 '404': *6 x-github: githubCloudOnly: false @@ -68012,9 +68568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -68039,17 +68595,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *410 + schema: *412 examples: - default: &411 + default: &413 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -68075,9 +68631,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -68129,9 +68685,9 @@ paths: description: Response content: application/json: - schema: *410 + schema: *412 examples: - default: *411 + default: *413 '404': *6 '422': *15 x-github: @@ -68153,9 +68709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -68179,9 +68735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response @@ -68215,9 +68771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -68284,9 +68840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -68350,9 +68906,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: content: application/json: @@ -68418,15 +68974,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response content: application/json: - schema: *404 + schema: *406 examples: default: value: @@ -68517,9 +69073,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '204': description: Response @@ -68542,9 +69098,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response @@ -68554,7 +69110,7 @@ paths: type: array items: *5 examples: - default: &412 + default: &414 value: - id: 1 slug: octoapp @@ -68611,9 +69167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -68647,7 +69203,7 @@ paths: type: array items: *5 examples: - default: *412 + default: *414 '422': *15 x-github: githubCloudOnly: false @@ -68668,9 +69224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -68704,7 +69260,7 @@ paths: type: array items: *5 examples: - default: *412 + default: *414 '422': *15 x-github: githubCloudOnly: false @@ -68725,9 +69281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -68761,7 +69317,7 @@ paths: type: array items: *5 examples: - default: *412 + default: *414 '422': *15 x-github: githubCloudOnly: false @@ -68783,9 +69339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response @@ -68815,9 +69371,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -68876,9 +69432,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: false content: @@ -68937,9 +69493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: content: application/json: @@ -68998,9 +69554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 responses: '200': description: Response @@ -69034,9 +69590,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -69094,9 +69650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -69154,9 +69710,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -69216,9 +69772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 requestBody: required: true content: @@ -69240,7 +69796,7 @@ paths: description: Response content: application/json: - schema: *413 + schema: *415 examples: default: value: @@ -69356,8 +69912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -69636,7 +70192,7 @@ paths: description: Response content: application/json: - schema: &414 + schema: &416 title: CheckRun description: A check performed on the code of a given code change type: object @@ -69772,7 +70328,7 @@ paths: check. type: array items: *85 - deployment: &752 + deployment: &767 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -70059,9 +70615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *337 - - *338 - - &415 + - *339 + - *340 + - &417 name: check_run_id description: The unique identifier of the check run. in: path @@ -70073,9 +70629,9 @@ paths: description: Response content: application/json: - schema: *414 + schema: *416 examples: - default: &416 + default: &418 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -70175,9 +70731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *337 - - *338 - - *415 + - *339 + - *340 + - *417 requestBody: required: true content: @@ -70417,9 +70973,9 @@ paths: description: Response content: application/json: - schema: *414 + schema: *416 examples: - default: *416 + default: *418 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70439,9 +70995,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *337 - - *338 - - *415 + - *339 + - *340 + - *417 - *17 - *19 responses: @@ -70551,9 +71107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *337 - - *338 - - *415 + - *339 + - *340 + - *417 responses: '201': description: Response @@ -70597,8 +71153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -70620,7 +71176,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &418 + schema: &420 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -70718,7 +71274,7 @@ paths: - string - 'null' format: date-time - head_commit: *417 + head_commit: *419 latest_check_runs_count: type: integer check_runs_url: @@ -70746,7 +71302,7 @@ paths: - check_runs_url - pull_requests examples: - default: &419 + default: &421 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -71037,9 +71593,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *418 + schema: *420 examples: - default: *419 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71058,8 +71614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -71368,9 +71924,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *337 - - *338 - - &420 + - *339 + - *340 + - &422 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -71382,9 +71938,9 @@ paths: description: Response content: application/json: - schema: *418 + schema: *420 examples: - default: *419 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71407,17 +71963,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *337 - - *338 - - *420 - - &475 + - *339 + - *340 + - *422 + - &477 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &476 + - &478 name: status description: Returns check runs with the specified `status`. in: query @@ -71456,9 +72012,9 @@ paths: type: integer check_runs: type: array - items: *414 + items: *416 examples: - default: &477 + default: &479 value: total_count: 1 check_runs: @@ -71560,9 +72116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *337 - - *338 - - *420 + - *339 + - *340 + - *422 responses: '201': description: Response @@ -71591,8 +72147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *60 - *45 @@ -71614,7 +72170,7 @@ paths: application/json: schema: type: array - items: &421 + items: &423 description: Code quality finding type: object properties: @@ -71744,7 +72300,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': &422 + '403': &424 description: Response if the user is not authorized to access Code quality for this repository. content: @@ -71771,8 +72327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding parameters: - - *337 - - *338 + - *339 + - *340 - name: finding_number in: path description: The number that identifies a finding. @@ -71784,7 +72340,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *423 examples: default: value: @@ -71813,7 +72369,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': *422 + '403': *424 '404': *6 '503': *114 x-github: @@ -71835,8 +72391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -71908,7 +72464,7 @@ paths: runner_label: updated_at: '2023-01-01T00:00:00Z' schedule: weekly - '403': *422 + '403': *424 '404': *6 '503': *114 x-github: @@ -71929,8 +72485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -72060,21 +72616,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *337 - - *338 - - *423 - - *424 + - *339 + - *340 + - *425 + - *426 - *19 - *17 - - &441 + - &443 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: *425 - - &442 + schema: *427 + - &444 name: pr description: The number of the pull request for the results you want to list. in: query @@ -72099,13 +72655,13 @@ paths: be returned. in: query required: false - schema: *426 + schema: *428 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *427 + schema: *429 - name: assignees description: | Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). @@ -72129,7 +72685,7 @@ paths: updated_at: *182 url: *183 html_url: *184 - instances_url: *428 + instances_url: *430 state: *189 fixed_at: *185 dismissed_by: @@ -72137,11 +72693,11 @@ paths: - type: 'null' - *4 dismissed_at: *186 - dismissed_reason: *429 - dismissed_comment: *430 - rule: *431 - tool: *432 - most_recent_instance: *433 + dismissed_reason: *431 + dismissed_comment: *432 + rule: *433 + tool: *434 + most_recent_instance: *435 dismissal_approved_by: anyOf: - type: 'null' @@ -72264,7 +72820,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &434 + '403': &436 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -72291,9 +72847,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *337 - - *338 - - &435 + - *339 + - *340 + - &437 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -72307,7 +72863,7 @@ paths: description: Response content: application/json: - schema: &436 + schema: &438 type: object properties: number: *180 @@ -72315,7 +72871,7 @@ paths: updated_at: *182 url: *183 html_url: *184 - instances_url: *428 + instances_url: *430 state: *189 fixed_at: *185 dismissed_by: @@ -72323,8 +72879,8 @@ paths: - type: 'null' - *4 dismissed_at: *186 - dismissed_reason: *429 - dismissed_comment: *430 + dismissed_reason: *431 + dismissed_comment: *432 rule: type: object properties: @@ -72386,8 +72942,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *432 - most_recent_instance: *433 + tool: *434 + most_recent_instance: *435 dismissal_approved_by: anyOf: - type: 'null' @@ -72483,7 +73039,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -72503,9 +73059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 requestBody: required: true content: @@ -72520,8 +73076,8 @@ paths: enum: - open - dismissed - dismissed_reason: *429 - dismissed_comment: *430 + dismissed_reason: *431 + dismissed_comment: *432 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -72549,7 +73105,7 @@ paths: description: Response content: application/json: - schema: *436 + schema: *438 examples: default: value: @@ -72625,7 +73181,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &440 + '403': &442 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -72652,15 +73208,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: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 responses: '200': description: Response content: application/json: - schema: &437 + schema: &439 type: object properties: status: @@ -72687,13 +73243,13 @@ paths: - description - started_at examples: - default: &438 + default: &440 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &439 + '400': &441 description: Bad Request content: application/json: @@ -72704,7 +73260,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': *434 + '403': *436 '404': *6 '500': *53 x-github: @@ -72729,29 +73285,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: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 responses: '200': description: OK content: application/json: - schema: *437 + schema: *439 examples: - default: *438 + default: *440 '202': description: Accepted content: application/json: - schema: *437 + schema: *439 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *439 + '400': *441 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -72783,9 +73339,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: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 requestBody: required: false content: @@ -72831,8 +73387,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *439 - '403': *440 + '400': *441 + '403': *442 '404': *6 '422': description: Unprocessable Entity @@ -72856,13 +73412,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 - *19 - *17 - - *441 - - *442 + - *443 + - *444 responses: '200': description: Response @@ -72873,10 +73429,10 @@ paths: items: type: object properties: - ref: *425 - analysis_key: *443 - environment: *444 - category: *445 + ref: *427 + analysis_key: *445 + environment: *446 + category: *447 state: type: - string @@ -72893,7 +73449,7 @@ paths: properties: text: type: string - location: *446 + location: *448 html_url: type: string classifications: @@ -72901,7 +73457,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: *447 + items: *449 examples: default: value: @@ -72938,7 +73494,7 @@ paths: end_column: 50 classifications: - source - '403': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -72972,25 +73528,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *337 - - *338 - - *423 - - *424 + - *339 + - *340 + - *425 + - *426 - *19 - *17 - - *442 + - *444 - 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: *425 + schema: *427 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &448 + schema: &450 type: string description: An identifier for the upload. examples: @@ -73012,23 +73568,23 @@ paths: application/json: schema: type: array - items: &449 + items: &451 type: object properties: - ref: *425 - commit_sha: &457 + ref: *427 + commit_sha: &459 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: *443 + analysis_key: *445 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *445 + category: *447 error: type: string examples: @@ -73053,8 +73609,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *448 - tool: *432 + sarif_id: *450 + tool: *434 deletable: type: boolean warning: @@ -73116,7 +73672,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -73152,8 +73708,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: - - *337 - - *338 + - *339 + - *340 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -73166,7 +73722,7 @@ paths: description: Response content: application/json: - schema: *449 + schema: *451 examples: response: summary: application/json response @@ -73220,7 +73776,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *434 + '403': *436 '404': *6 '422': description: Response if analysis could not be processed @@ -73307,8 +73863,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: - - *337 - - *338 + - *339 + - *340 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -73364,7 +73920,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': *440 + '403': *442 '404': *6 '503': *114 x-github: @@ -73386,8 +73942,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -73395,7 +73951,7 @@ paths: application/json: schema: type: array - items: &450 + items: &452 title: CodeQL Database description: A CodeQL database. type: object @@ -73507,7 +74063,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': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -73536,8 +74092,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - name: language in: path description: The language of the CodeQL database. @@ -73549,7 +74105,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *452 examples: default: value: @@ -73581,9 +74137,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': &484 + '302': &486 description: Found - '403': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -73605,8 +74161,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *337 - - *338 + - *339 + - *340 - name: language in: path description: The language of the CodeQL database. @@ -73616,7 +74172,7 @@ paths: responses: '204': description: Response - '403': *440 + '403': *442 '404': *6 '503': *114 x-github: @@ -73644,8 +74200,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -73654,7 +74210,7 @@ paths: type: object additionalProperties: false properties: - language: &451 + language: &453 type: string description: The language targeted by the CodeQL query enum: @@ -73734,7 +74290,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &455 + schema: &457 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -73744,7 +74300,7 @@ paths: description: The ID of the variant analysis. controller_repo: *65 actor: *4 - query_language: *451 + query_language: *453 query_pack_url: type: string description: The download url for the query pack. @@ -73792,7 +74348,7 @@ paths: items: type: object properties: - repository: &452 + repository: &454 title: Repository Identifier description: Repository Identifier type: object @@ -73834,7 +74390,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &456 + analysis_status: &458 type: string description: The new status of the CodeQL variant analysis repository task. @@ -73866,7 +74422,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &453 + access_mismatch_repos: &455 type: object properties: repository_count: @@ -73881,7 +74437,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: *452 + items: *454 required: - repository_count - repositories @@ -73904,8 +74460,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *453 - over_limit_repos: *453 + no_codeql_db_repos: *455 + over_limit_repos: *455 required: - access_mismatch_repos - not_found_repos @@ -73921,7 +74477,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &454 + value: &456 summary: Default response value: id: 1 @@ -74067,10 +74623,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *454 + value: *456 repository_lists: summary: Response for a successful variant analysis submission - value: *454 + value: *456 '404': *6 '422': description: Unable to process variant analysis submission @@ -74098,8 +74654,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: - - *337 - - *338 + - *339 + - *340 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -74111,9 +74667,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *457 examples: - default: *454 + default: *456 '404': *6 '503': *114 x-github: @@ -74136,7 +74692,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: - - *337 + - *339 - name: repo in: path description: The name of the controller repository. @@ -74171,7 +74727,7 @@ paths: type: object properties: repository: *65 - analysis_status: *456 + analysis_status: *458 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -74296,8 +74852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -74390,7 +74946,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *434 + '403': *436 '404': *6 '503': *114 x-github: @@ -74411,8 +74967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -74506,7 +75062,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *440 + '403': *442 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -74577,8 +75133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -74586,7 +75142,7 @@ paths: schema: type: object properties: - commit_sha: *457 + commit_sha: *459 ref: type: string description: |- @@ -74646,7 +75202,7 @@ paths: schema: type: object properties: - id: *448 + id: *450 url: type: string description: The REST API URL for checking the status of the upload. @@ -74660,7 +75216,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': *440 + '403': *442 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -74683,8 +75239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *337 - - *338 + - *339 + - *340 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -74732,7 +75288,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': *434 + '403': *436 '404': description: Not Found if the sarif id does not match any upload '503': *114 @@ -74757,8 +75313,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -74839,8 +75395,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *337 - - *338 + - *339 + - *340 - 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 @@ -74968,8 +75524,8 @@ paths: parameters: - *17 - *19 - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -75283,8 +75839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -75350,7 +75906,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -75358,7 +75914,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '400': *14 '401': *23 '403': *27 @@ -75387,8 +75943,8 @@ paths: parameters: - *17 - *19 - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -75452,8 +76008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -75490,9 +76046,9 @@ paths: type: integer machines: type: array - items: *459 + items: *461 examples: - default: &695 + default: &710 value: total_count: 2 machines: @@ -75532,8 +76088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *337 - - *338 + - *339 + - *340 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -75620,8 +76176,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: - - *337 - - *338 + - *339 + - *340 - 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 @@ -75690,8 +76246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -75709,7 +76265,7 @@ paths: type: integer secrets: type: array - items: &463 + items: &465 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -75730,7 +76286,7 @@ paths: - created_at - updated_at examples: - default: *460 + default: *462 headers: Link: *66 x-github: @@ -75753,16 +76309,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *461 + schema: *463 examples: - default: *462 + default: *464 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75782,17 +76338,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '200': description: Response content: application/json: - schema: *463 + schema: *465 examples: - default: *464 + default: *466 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75812,8 +76368,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 requestBody: required: true @@ -75866,8 +76422,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '204': @@ -75896,8 +76452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *337 - - *338 + - *339 + - *340 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -75935,7 +76491,7 @@ paths: application/json: schema: type: array - items: &465 + items: &467 title: Collaborator description: Collaborator type: object @@ -76128,8 +76684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *337 - - *338 + - *339 + - *340 - *70 responses: '204': @@ -76176,8 +76732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *337 - - *338 + - *339 + - *340 - *70 requestBody: required: false @@ -76204,7 +76760,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &534 + schema: &536 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -76432,8 +76988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *337 - - *338 + - *339 + - *340 - *70 responses: '204': @@ -76465,8 +77021,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *337 - - *338 + - *339 + - *340 - *70 responses: '200': @@ -76487,7 +77043,7 @@ paths: user: anyOf: - type: 'null' - - *465 + - *467 required: - permission - role_name @@ -76541,8 +77097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -76552,7 +77108,7 @@ paths: application/json: schema: type: array - items: &466 + items: &468 title: Commit Comment description: Commit Comment type: object @@ -76610,7 +77166,7 @@ paths: - created_at - updated_at examples: - default: &471 + default: &473 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76669,17 +77225,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '200': description: Response content: application/json: - schema: *466 + schema: *468 examples: - default: &472 + default: &474 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -76736,8 +77292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -76760,7 +77316,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *468 examples: default: value: @@ -76811,8 +77367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '204': @@ -76834,8 +77390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -76862,7 +77418,7 @@ paths: application/json: schema: type: array - items: &467 + items: &469 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -76906,7 +77462,7 @@ paths: - content - created_at examples: - default: &538 + default: &540 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -76951,8 +77507,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -76985,9 +77541,9 @@ paths: description: Reaction exists content: application/json: - schema: *467 + schema: *469 examples: - default: &468 + default: &470 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -77016,9 +77572,9 @@ paths: description: Reaction created content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '422': *15 x-github: githubCloudOnly: false @@ -77040,10 +77596,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *337 - - *338 + - *339 + - *340 - *96 - - &539 + - &541 name: reaction_id description: The unique identifier of the reaction. in: path @@ -77098,8 +77654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *337 - - *338 + - *339 + - *340 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77155,9 +77711,9 @@ paths: application/json: schema: type: array - items: *469 + items: *471 examples: - default: &600 + default: &602 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77251,9 +77807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *337 - - *338 - - &470 + - *339 + - *340 + - &472 name: commit_sha description: The SHA of the commit. in: path @@ -77325,9 +77881,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *337 - - *338 - - *470 + - *339 + - *340 + - *472 - *17 - *19 responses: @@ -77337,9 +77893,9 @@ paths: application/json: schema: type: array - items: *466 + items: *468 examples: - default: *471 + default: *473 headers: Link: *66 x-github: @@ -77367,9 +77923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *337 - - *338 - - *470 + - *339 + - *340 + - *472 requestBody: required: true content: @@ -77404,9 +77960,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *468 examples: - default: *472 + default: *474 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77434,9 +77990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *337 - - *338 - - *470 + - *339 + - *340 + - *472 - *17 - *19 responses: @@ -77446,9 +78002,9 @@ paths: application/json: schema: type: array - items: *473 + items: *475 examples: - default: &592 + default: &594 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -77985,11 +78541,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *337 - - *338 + - *339 + - *340 - *19 - *17 - - &474 + - &476 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)" @@ -78004,9 +78560,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *471 examples: - default: &580 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78094,7 +78650,7 @@ paths: schema: type: string examples: - default: &481 + default: &483 value: | diff --git a/testfile b/testfile index 9bdeaeb..912c7ef 100644 @@ -78107,7 +78663,7 @@ paths: schema: type: string examples: - default: &482 + default: &484 value: | From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 From: Mona Lisa <87831417+monalisa@users.noreply.github.com> @@ -78160,11 +78716,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *337 - - *338 - - *474 - - *475 + - *339 + - *340 - *476 + - *477 + - *478 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78198,9 +78754,9 @@ paths: type: integer check_runs: type: array - items: *414 + items: *416 examples: - default: *477 + default: *479 headers: Link: *66 x-github: @@ -78225,9 +78781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *337 - - *338 - - *474 + - *339 + - *340 + - *476 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78235,7 +78791,7 @@ paths: schema: type: integer example: 1 - - *475 + - *477 - *17 - *19 responses: @@ -78253,7 +78809,7 @@ paths: type: integer check_suites: type: array - items: *418 + items: *420 examples: default: value: @@ -78453,9 +79009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *337 - - *338 - - *474 + - *339 + - *340 + - *476 - *17 - *19 responses: @@ -78657,9 +79213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *337 - - *338 - - *474 + - *339 + - *340 + - *476 - *17 - *19 responses: @@ -78669,7 +79225,7 @@ paths: application/json: schema: type: array - items: &673 + items: &688 title: Status description: The status of a commit. type: object @@ -78750,7 +79306,7 @@ paths: site_admin: false headers: Link: *66 - '301': *341 + '301': *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78778,8 +79334,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -78812,11 +79368,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *478 + - *480 code_of_conduct_file: anyOf: - type: 'null' - - &479 + - &481 title: Community Health File type: object properties: @@ -78836,19 +79392,19 @@ paths: contributing: anyOf: - type: 'null' - - *479 + - *481 readme: anyOf: - type: 'null' - - *479 + - *481 issue_template: anyOf: - type: 'null' - - *479 + - *481 pull_request_template: anyOf: - type: 'null' - - *479 + - *481 required: - code_of_conduct - code_of_conduct_file @@ -78977,8 +79533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *337 - - *338 + - *339 + - *340 - *19 - *17 - name: basehead @@ -79026,8 +79582,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *469 - merge_base_commit: *469 + base_commit: *471 + merge_base_commit: *471 status: type: string enum: @@ -79051,10 +79607,10 @@ paths: - 6 commits: type: array - items: *469 + items: *471 files: type: array - items: *480 + items: *482 required: - url - html_url @@ -79300,12 +79856,12 @@ paths: schema: type: string examples: - default: *481 + default: *483 application/vnd.github.patch: schema: type: string examples: - default: *482 + default: *484 '404': *6 '500': *53 '503': *114 @@ -79350,8 +79906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *337 - - *338 + - *339 + - *340 - name: path description: path parameter in: path @@ -79521,7 +80077,7 @@ paths: - type - url examples: - response-if-content-is-a-file-github-object: &483 + response-if-content-is-a-file-github-object: &485 summary: Response if content is a file value: type: file @@ -79658,7 +80214,7 @@ paths: - size - type - url - - &605 + - &607 title: Content File description: Content File type: object @@ -79876,7 +80432,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *483 + response-if-content-is-a-file: *485 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -79945,7 +80501,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *484 + '302': *486 '304': *35 x-github: githubCloudOnly: false @@ -79968,8 +80524,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *337 - - *338 + - *339 + - *340 - name: path description: path parameter in: path @@ -80064,7 +80620,7 @@ paths: description: Response content: application/json: - schema: &485 + schema: &487 title: File Commit description: File Commit type: object @@ -80220,7 +80776,7 @@ paths: description: Response content: application/json: - schema: *485 + schema: *487 examples: example-for-creating-a-file: value: @@ -80274,7 +80830,7 @@ paths: schema: oneOf: - *3 - - &515 + - &517 description: Repository rule violation was detected type: object properties: @@ -80295,7 +80851,7 @@ paths: items: type: object properties: - placeholder_id: &665 + placeholder_id: &680 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80327,8 +80883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *337 - - *338 + - *339 + - *340 - name: path description: path parameter in: path @@ -80389,7 +80945,7 @@ paths: description: Response content: application/json: - schema: *485 + schema: *487 examples: default: value: @@ -80444,8 +81000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *337 - - *338 + - *339 + - *340 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -80575,8 +81131,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -80709,8 +81265,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *202 - *203 - *204 @@ -80723,7 +81279,7 @@ paths: schema: type: string - *207 - - *486 + - *488 - *208 - *209 - *210 @@ -80738,7 +81294,7 @@ paths: application/json: schema: type: array - items: &490 + items: &492 type: object description: A Dependabot alert. properties: @@ -80789,7 +81345,7 @@ paths: - transitive - inconclusive - - security_advisory: *487 + security_advisory: *489 security_vulnerability: *64 url: *183 html_url: *184 @@ -80820,8 +81376,8 @@ paths: dismissal. maxLength: 280 fixed_at: *185 - auto_dismissed_at: *488 - dismissal_request: *489 + auto_dismissed_at: *490 + dismissal_request: *491 assignees: type: array description: The users assigned to this alert. @@ -81076,9 +81632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *337 - - *338 - - &491 + - *339 + - *340 + - &493 name: alert_number in: path description: |- @@ -81093,7 +81649,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *492 examples: default: value: @@ -81225,9 +81781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *337 - - *338 - - *491 + - *339 + - *340 + - *493 requestBody: required: true content: @@ -81300,7 +81856,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *492 examples: default: value: @@ -81430,8 +81986,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -81449,7 +82005,7 @@ paths: type: integer secrets: type: array - items: &494 + items: &496 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81503,16 +82059,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *492 + schema: *494 examples: - default: *493 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81532,15 +82088,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '200': description: Response content: application/json: - schema: *494 + schema: *496 examples: default: value: @@ -81566,8 +82122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 requestBody: required: true @@ -81620,8 +82176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *337 - - *338 + - *339 + - *340 - *163 responses: '204': @@ -81644,8 +82200,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: - - *337 - - *338 + - *339 + - *340 - 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 @@ -81822,8 +82378,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -82082,8 +82638,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: - - *337 - - *338 + - *339 + - *340 - name: sbom_uuid in: path required: true @@ -82094,7 +82650,7 @@ paths: '302': description: Redirects to a temporary download URL for the completed SBOM. headers: - Location: *495 + Location: *497 '202': description: SBOM is still being processed, no content is returned. '404': *6 @@ -82115,8 +82671,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: - - *337 - - *338 + - *339 + - *340 responses: '201': description: Response @@ -82154,8 +82710,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -82238,7 +82794,7 @@ paths: - version - url additionalProperties: false - metadata: &496 + metadata: &498 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82277,7 +82833,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *496 + metadata: *498 resolved: type: object description: A collection of resolved package dependencies. @@ -82291,7 +82847,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *496 + metadata: *498 relationship: type: string description: A notation of whether a dependency is requested @@ -82424,8 +82980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *337 - - *338 + - *339 + - *340 - name: sha description: The SHA recorded at creation time. in: query @@ -82466,9 +83022,9 @@ paths: application/json: schema: type: array - items: *497 + items: *499 examples: - default: *498 + default: *500 headers: Link: *66 x-github: @@ -82534,8 +83090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -82617,7 +83173,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *499 examples: simple-example: summary: Simple example @@ -82690,9 +83246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *337 - - *338 - - &499 + - *339 + - *340 + - &501 name: deployment_id description: deployment_id parameter in: path @@ -82704,7 +83260,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *499 examples: default: value: @@ -82769,9 +83325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *337 - - *338 - - *499 + - *339 + - *340 + - *501 responses: '204': description: Response @@ -82793,9 +83349,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *337 - - *338 - - *499 + - *339 + - *340 + - *501 - *17 - *19 responses: @@ -82805,7 +83361,7 @@ paths: application/json: schema: type: array - items: &500 + items: &502 title: Deployment Status description: The status of a deployment. type: object @@ -82969,9 +83525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *337 - - *338 - - *499 + - *339 + - *340 + - *501 requestBody: required: true content: @@ -83046,9 +83602,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *502 examples: - default: &501 + default: &503 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83104,9 +83660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *337 - - *338 - - *499 + - *339 + - *340 + - *501 - name: status_id in: path required: true @@ -83117,9 +83673,9 @@ paths: description: Response content: application/json: - schema: *500 + schema: *502 examples: - default: *501 + default: *503 '404': *6 x-github: githubCloudOnly: false @@ -83144,8 +83700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -83202,8 +83758,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -83221,7 +83777,7 @@ paths: - 5 environments: type: array - items: &503 + items: &505 title: Environment description: Details of a deployment environment type: object @@ -83283,7 +83839,7 @@ paths: type: string examples: - wait_timer - wait_timer: &505 + wait_timer: &507 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -83325,7 +83881,7 @@ paths: items: type: object properties: - type: *502 + type: *504 reviewer: anyOf: - *4 @@ -83352,7 +83908,7 @@ paths: - id - node_id - type - deployment_branch_policy: &506 + deployment_branch_policy: &508 type: - object - 'null' @@ -83469,9 +84025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *337 - - *338 - - &504 + - *339 + - *340 + - &506 name: environment_name in: path required: true @@ -83484,9 +84040,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *505 examples: - default: &507 + default: &509 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -83570,9 +84126,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 requestBody: required: false content: @@ -83582,7 +84138,7 @@ paths: - object - 'null' properties: - wait_timer: *505 + wait_timer: *507 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -83601,14 +84157,14 @@ paths: items: type: object properties: - type: *502 + type: *504 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *506 + deployment_branch_policy: *508 additionalProperties: false examples: default: @@ -83628,9 +84184,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *505 examples: - default: *507 + default: *509 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -83654,9 +84210,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 responses: '204': description: Default response @@ -83681,9 +84237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *17 - *19 responses: @@ -83702,7 +84258,7 @@ paths: - 2 branch_policies: type: array - items: &508 + items: &510 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -83763,9 +84319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 requestBody: required: true content: @@ -83813,9 +84369,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: - example-wildcard: &509 + example-wildcard: &511 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -83857,10 +84413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *337 - - *338 - - *504 - - &510 + - *339 + - *340 + - *506 + - &512 name: branch_policy_id in: path required: true @@ -83872,9 +84428,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: - default: *509 + default: *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83893,10 +84449,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *337 - - *338 - - *504 - - *510 + - *339 + - *340 + - *506 + - *512 requestBody: required: true content: @@ -83925,9 +84481,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: - default: *509 + default: *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83946,10 +84502,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *337 - - *338 - - *504 - - *510 + - *339 + - *340 + - *506 + - *512 responses: '204': description: Response @@ -83974,9 +84530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *504 - - *338 - - *337 + - *506 + - *340 + - *339 responses: '200': description: List of deployment protection rules @@ -83993,7 +84549,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &511 + items: &513 title: Deployment protection rule description: Deployment protection rule type: object @@ -84015,7 +84571,7 @@ paths: for the environment. examples: - true - app: &512 + app: &514 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84118,9 +84674,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: - - *504 - - *338 - - *337 + - *506 + - *340 + - *339 requestBody: content: application/json: @@ -84141,9 +84697,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *511 + schema: *513 examples: - default: &513 + default: &515 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84178,9 +84734,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: - - *504 - - *338 - - *337 + - *506 + - *340 + - *339 - *19 - *17 responses: @@ -84200,7 +84756,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *512 + items: *514 examples: default: value: @@ -84235,10 +84791,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *337 - - *338 - - *504 - - &514 + - *339 + - *340 + - *506 + - &516 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84250,9 +84806,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *513 examples: - default: *513 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84273,10 +84829,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *504 - - *338 - - *337 - - *514 + - *506 + - *340 + - *339 + - *516 responses: '204': description: Response @@ -84302,9 +84858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *17 - *19 responses: @@ -84322,9 +84878,9 @@ paths: type: integer secrets: type: array - items: *381 + items: *383 examples: - default: *382 + default: *384 headers: Link: *66 x-github: @@ -84349,9 +84905,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 responses: '200': description: Response @@ -84381,18 +84937,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *163 responses: '200': description: Response content: application/json: - schema: *381 + schema: *383 examples: - default: *395 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84414,9 +84970,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *163 requestBody: required: true @@ -84474,9 +85030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *163 responses: '204': @@ -84502,9 +85058,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *172 - *19 responses: @@ -84522,9 +85078,9 @@ paths: type: integer variables: type: array - items: *383 + items: *385 examples: - default: *384 + default: *386 headers: Link: *66 x-github: @@ -84547,9 +85103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 requestBody: required: true content: @@ -84601,18 +85157,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *337 - - *338 - - *504 + - *339 + - *340 + - *506 - *166 responses: '200': description: Response content: application/json: - schema: *383 + schema: *385 examples: - default: *396 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84633,10 +85189,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 - - *504 + - *506 requestBody: required: true content: @@ -84678,10 +85234,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *337 - - *338 + - *339 + - *340 - *166 - - *504 + - *506 responses: '204': description: Response @@ -84703,8 +85259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -84772,8 +85328,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *337 - - *338 + - *339 + - *340 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -84932,8 +85488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -84966,9 +85522,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *342 + default: *344 '400': *14 '422': *15 '403': *27 @@ -84989,8 +85545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -85050,7 +85606,7 @@ paths: schema: oneOf: - *124 - - *515 + - *517 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85075,8 +85631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *337 - - *338 + - *339 + - *340 - name: file_sha in: path required: true @@ -85176,8 +85732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -85286,7 +85842,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &518 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -85513,15 +86069,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *337 - - *338 - - *470 + - *339 + - *340 + - *472 responses: '200': description: Response content: application/json: - schema: *516 + schema: *518 examples: default: value: @@ -85577,9 +86133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *337 - - *338 - - &517 + - *339 + - *340 + - &519 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. @@ -85596,7 +86152,7 @@ paths: application/json: schema: type: array - items: &518 + items: &520 title: Git Reference description: Git references within a repository type: object @@ -85672,17 +86228,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *337 - - *338 - - *517 + - *339 + - *340 + - *519 responses: '200': description: Response content: application/json: - schema: *518 + schema: *520 examples: - default: &519 + default: &521 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -85711,8 +86267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -85741,9 +86297,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *520 examples: - default: *519 + default: *521 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -85769,9 +86325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *337 - - *338 - - *517 + - *339 + - *340 + - *519 requestBody: required: true content: @@ -85800,9 +86356,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *520 examples: - default: *519 + default: *521 '422': *15 '409': *52 x-github: @@ -85820,9 +86376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *337 - - *338 - - *517 + - *339 + - *340 + - *519 responses: '204': description: Response @@ -85877,8 +86433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -85945,7 +86501,7 @@ paths: description: Response content: application/json: - schema: &521 + schema: &523 title: Git Tag description: Metadata for a Git tag type: object @@ -86001,7 +86557,7 @@ paths: - sha - type - url - verification: *520 + verification: *522 required: - sha - url @@ -86011,7 +86567,7 @@ paths: - tag - message examples: - default: &522 + default: &524 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86084,8 +86640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *337 - - *338 + - *339 + - *340 - name: tag_sha in: path required: true @@ -86096,9 +86652,9 @@ paths: description: Response content: application/json: - schema: *521 + schema: *523 examples: - default: *522 + default: *524 '404': *6 '409': *52 x-github: @@ -86122,8 +86678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -86197,7 +86753,7 @@ paths: description: Response content: application/json: - schema: &523 + schema: &525 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86299,8 +86855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *337 - - *338 + - *339 + - *340 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86323,7 +86879,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *525 examples: default-response: summary: Default response @@ -86381,8 +86937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-the-hash-algorithm-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -86426,8 +86982,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -86437,7 +86993,7 @@ paths: application/json: schema: type: array - items: &524 + items: &526 title: Webhook description: Webhooks for repositories. type: object @@ -86500,7 +87056,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &783 + last_response: &798 title: Hook Response type: object properties: @@ -86577,8 +87133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -86631,9 +87187,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *526 examples: - default: &525 + default: &527 value: type: Repository id: 12345678 @@ -86681,17 +87237,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 responses: '200': description: Response content: application/json: - schema: *524 + schema: *526 examples: - default: *525 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -86711,8 +87267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 requestBody: required: true @@ -86758,9 +87314,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *526 examples: - default: *525 + default: *527 '422': *15 '404': *6 x-github: @@ -86781,8 +87337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 responses: '204': @@ -86807,8 +87363,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *218 responses: '200': @@ -86836,8 +87392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *218 requestBody: required: false @@ -86882,8 +87438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 - *17 - *219 @@ -86916,8 +87472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 - *16 responses: @@ -86946,8 +87502,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 - *16 responses: @@ -86971,8 +87527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 responses: '204': @@ -86998,8 +87554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *337 - - *338 + - *339 + - *340 - *218 responses: '204': @@ -87023,8 +87579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response if immutable releases are enabled @@ -87072,8 +87628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': *59 '409': *52 @@ -87093,8 +87649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': *59 '409': *52 @@ -87151,14 +87707,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: &526 + schema: &528 title: Import description: A repository import from an external source. type: object @@ -87265,7 +87821,7 @@ paths: - html_url - authors_url examples: - default: &529 + default: &531 value: vcs: subversion use_lfs: true @@ -87281,7 +87837,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': &527 + '503': &529 description: Unavailable due to service under maintenance. content: application/json: @@ -87310,8 +87866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -87359,7 +87915,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *528 examples: default: value: @@ -87384,7 +87940,7 @@ paths: type: string '422': *15 '404': *6 - '503': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87412,8 +87968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -87465,7 +88021,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *528 examples: example-1: summary: Example 1 @@ -87513,7 +88069,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': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87536,12 +88092,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response - '503': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87567,9 +88123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *337 - - *338 - - &717 + - *339 + - *340 + - &732 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -87583,7 +88139,7 @@ paths: application/json: schema: type: array - items: &528 + items: &530 title: Porter Author description: Porter Author type: object @@ -87637,7 +88193,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': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87662,8 +88218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *337 - - *338 + - *339 + - *340 - name: author_id in: path required: true @@ -87693,7 +88249,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *530 examples: default: value: @@ -87706,7 +88262,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87730,8 +88286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -87772,7 +88328,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87800,8 +88356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -87828,11 +88384,11 @@ paths: description: Response content: application/json: - schema: *526 + schema: *528 examples: - default: *529 + default: *531 '422': *15 - '503': *527 + '503': *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87855,8 +88411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -87864,8 +88420,8 @@ paths: application/json: schema: *20 examples: - default: *530 - '301': *341 + default: *532 + '301': *343 '404': *6 x-github: githubCloudOnly: false @@ -87885,8 +88441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -87899,7 +88455,7 @@ paths: properties: {} additionalProperties: false examples: - default: &532 + default: &534 value: limit: collaborators_only origin: repository @@ -87924,13 +88480,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *531 + schema: *533 examples: default: summary: Example request body @@ -87944,7 +88500,7 @@ paths: application/json: schema: *237 examples: - default: *532 + default: *534 '409': description: Response x-github: @@ -87966,8 +88522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -87994,8 +88550,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -88049,13 +88605,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: &533 + schema: &535 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. @@ -88105,13 +88661,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: application/json: - schema: *533 + schema: *535 examples: default: summary: Example request body @@ -88144,8 +88700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -88198,8 +88754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -88275,8 +88831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -88286,9 +88842,9 @@ paths: application/json: schema: type: array - items: *534 + items: *536 examples: - default: &710 + default: &725 value: - id: 1 repository: @@ -88419,8 +88975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *337 - - *338 + - *339 + - *340 - *241 requestBody: required: false @@ -88450,7 +89006,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *536 examples: default: value: @@ -88581,8 +89137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *337 - - *338 + - *339 + - *340 - *241 responses: '204': @@ -88606,8 +89162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/issue-types#list-issue-types-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -88617,7 +89173,7 @@ paths: type: array items: *245 examples: - default: *535 + default: *537 '404': *6 x-github: githubCloudOnly: false @@ -88646,8 +89202,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *337 - - *338 + - *339 + - *340 - 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 @@ -88734,7 +89290,7 @@ paths: type: array items: *82 examples: - default: &546 + default: &548 value: - id: 1 node_id: MDU6SXNzdWUx @@ -88883,7 +89439,7 @@ paths: state_reason: completed headers: Link: *66 - '301': *341 + '301': *343 '422': *15 '404': *6 x-github: @@ -88912,8 +89468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -89030,7 +89586,7 @@ paths: application/json: schema: *82 examples: - default: &543 + default: &545 value: id: 1 node_id: MDU6SXNzdWUx @@ -89187,7 +89743,7 @@ paths: '422': *15 '503': *114 '404': *6 - '410': *536 + '410': *538 x-github: triggersNotification: true githubCloudOnly: false @@ -89215,8 +89771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *104 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -89239,7 +89795,7 @@ paths: type: array items: *83 examples: - default: &545 + default: &547 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89298,8 +89854,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '200': @@ -89308,7 +89864,7 @@ paths: application/json: schema: *83 examples: - default: &537 + default: &539 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89364,8 +89920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -89390,7 +89946,7 @@ paths: application/json: schema: *83 examples: - default: *537 + default: *539 '422': *15 x-github: githubCloudOnly: false @@ -89408,8 +89964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '204': @@ -89438,8 +89994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '200': @@ -89502,7 +90058,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *536 + '410': *538 '422': *15 x-github: githubCloudOnly: false @@ -89519,8 +90075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '204': @@ -89528,7 +90084,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *536 + '410': *538 '503': *114 x-github: githubCloudOnly: false @@ -89546,8 +90102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -89574,9 +90130,9 @@ paths: application/json: schema: type: array - items: *467 + items: *469 examples: - default: *538 + default: *540 headers: Link: *66 '404': *6 @@ -89597,8 +90153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -89631,16 +90187,16 @@ paths: description: Reaction exists content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '201': description: Reaction created content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '422': *15 x-github: githubCloudOnly: false @@ -89662,10 +90218,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *337 - - *338 + - *339 + - *340 - *96 - - *539 + - *541 responses: '204': description: Response @@ -89685,8 +90241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -89696,7 +90252,7 @@ paths: application/json: schema: type: array - items: &542 + items: &544 title: Issue Event description: Issue Event type: object @@ -89843,7 +90399,7 @@ paths: required: - from - to - issue_type: &540 + issue_type: &542 title: Issue Type description: The type of issue. type: @@ -89874,11 +90430,11 @@ paths: required: - id - name - prev_issue_type: *540 + prev_issue_type: *542 sub_issue: anyOf: - type: 'null' - - &541 + - &543 title: Issue Reference description: A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency @@ -89936,15 +90492,15 @@ paths: parent_issue: anyOf: - type: 'null' - - *541 + - *543 blocked_by: anyOf: - type: 'null' - - *541 + - *543 blocking: anyOf: - type: 'null' - - *541 + - *543 author_association: *79 lock_reason: type: @@ -90138,8 +90694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *337 - - *338 + - *339 + - *340 - name: event_id in: path required: true @@ -90150,7 +90706,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *544 examples: default: value: @@ -90343,7 +90899,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *536 + '410': *538 '403': *27 x-github: githubCloudOnly: false @@ -90377,9 +90933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *337 - - *338 - - &544 + - *339 + - *340 + - &546 name: issue_number description: The number that identifies the issue. in: path @@ -90395,7 +90951,7 @@ paths: examples: default: summary: Issue - value: *543 + value: *545 pinned_comment: summary: Issue with pinned comment value: @@ -90594,9 +91150,9 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 '304': *35 x-github: githubCloudOnly: false @@ -90621,9 +91177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: false content: @@ -90783,13 +91339,13 @@ paths: - type: object properties: {} examples: - default: *543 + default: *545 '422': *15 '503': *114 '403': *27 - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90807,9 +91363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: false content: @@ -90837,7 +91393,7 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90853,9 +91409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: content: application/json: @@ -90882,7 +91438,7 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90904,9 +91460,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: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - name: assignee in: path required: true @@ -90946,9 +91502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *87 - *17 - *19 @@ -90961,11 +91517,11 @@ paths: type: array items: *83 examples: - default: *545 + default: *547 headers: Link: *66 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90994,9 +91550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -91020,14 +91576,14 @@ paths: application/json: schema: *83 examples: - default: *537 + default: *539 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *536 + '410': *538 '422': *15 '404': *6 x-github: @@ -91055,9 +91611,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -91069,12 +91625,12 @@ paths: type: array items: *82 examples: - default: *546 + default: *548 headers: Link: *66 - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91102,9 +91658,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -91128,15 +91684,15 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *341 + '301': *343 '403': *27 - '410': *536 + '410': *538 '422': *15 '404': *6 x-github: @@ -91167,9 +91723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -91183,13 +91739,13 @@ paths: application/json: schema: *82 examples: - default: *543 - '301': *341 + default: *545 + '301': *343 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *536 + '410': *538 x-github: triggersNotification: true githubCloudOnly: false @@ -91215,9 +91771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -91229,12 +91785,12 @@ paths: type: array items: *82 examples: - default: *546 + default: *548 headers: Link: *66 - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91251,9 +91807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -91267,7 +91823,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &550 + - &552 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -91316,7 +91872,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &551 + - &553 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91444,7 +92000,7 @@ paths: - performed_via_github_app - assignee - assigner - - &552 + - &554 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91490,7 +92046,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &553 + - &555 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91536,7 +92092,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &554 + - &556 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91585,7 +92141,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &555 + - &557 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91627,7 +92183,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &556 + - &558 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91669,7 +92225,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &557 + - &559 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91725,7 +92281,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &558 + - &560 title: Locked Issue Event description: Locked Issue Event type: object @@ -91770,7 +92326,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &559 + - &561 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91831,7 +92387,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &560 + - &562 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91892,7 +92448,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &561 + - &563 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91953,7 +92509,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &562 + - &564 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -92011,7 +92567,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &565 + - &567 title: Issue Type Added Issue Event description: Issue Type Added Issue Event type: object @@ -92039,7 +92595,7 @@ paths: anyOf: - type: 'null' - *5 - issue_type: *540 + issue_type: *542 required: - issue_type - id @@ -92051,7 +92607,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &566 + - &568 title: Issue Type Removed Issue Event description: Issue Type Removed Issue Event type: object @@ -92079,7 +92635,7 @@ paths: anyOf: - type: 'null' - *5 - prev_issue_type: *540 + prev_issue_type: *542 required: - prev_issue_type - id @@ -92091,7 +92647,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &567 + - &569 title: Issue Type Changed Issue Event description: Issue Type Changed Issue Event type: object @@ -92119,8 +92675,8 @@ paths: anyOf: - type: 'null' - *5 - issue_type: *540 - prev_issue_type: *540 + issue_type: *542 + prev_issue_type: *542 required: - issue_type - prev_issue_type @@ -92133,7 +92689,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &568 + - &570 title: Sub-issue Added Issue Event description: Sub-issue Added Issue Event type: object @@ -92164,7 +92720,7 @@ paths: sub_issue: anyOf: - type: 'null' - - *541 + - *543 required: - sub_issue - id @@ -92176,7 +92732,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &569 + - &571 title: Sub-issue Removed Issue Event description: Sub-issue Removed Issue Event type: object @@ -92207,7 +92763,7 @@ paths: sub_issue: anyOf: - type: 'null' - - *541 + - *543 required: - sub_issue - id @@ -92219,7 +92775,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &570 + - &572 title: Parent-issue Added Issue Event description: Parent-issue Added Issue Event type: object @@ -92250,7 +92806,7 @@ paths: parent_issue: anyOf: - type: 'null' - - *541 + - *543 required: - parent_issue - id @@ -92262,7 +92818,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &571 + - &573 title: Parent-issue Removed Issue Event description: Parent-issue Removed Issue Event type: object @@ -92293,7 +92849,7 @@ paths: parent_issue: anyOf: - type: 'null' - - *541 + - *543 required: - parent_issue - id @@ -92305,7 +92861,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &572 + - &574 title: Blocked-by Added Issue Event description: Blocked-by Added Issue Event type: object @@ -92336,7 +92892,7 @@ paths: blocked_by: anyOf: - type: 'null' - - *541 + - *543 required: - blocked_by - id @@ -92348,7 +92904,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &573 + - &575 title: Blocked-by Removed Issue Event description: Blocked-by Removed Issue Event type: object @@ -92379,7 +92935,7 @@ paths: blocked_by: anyOf: - type: 'null' - - *541 + - *543 required: - blocked_by - id @@ -92391,7 +92947,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &574 + - &576 title: Blocking Added Issue Event description: Blocking Added Issue Event type: object @@ -92422,7 +92978,7 @@ paths: blocking: anyOf: - type: 'null' - - *541 + - *543 required: - blocking - id @@ -92434,7 +92990,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &575 + - &577 title: Blocking Removed Issue Event description: Blocking Removed Issue Event type: object @@ -92465,7 +93021,7 @@ paths: blocking: anyOf: - type: 'null' - - *541 + - *543 required: - blocking - id @@ -92512,7 +93068,7 @@ paths: color: red headers: Link: *66 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92529,9 +93085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -92541,9 +93097,9 @@ paths: application/json: schema: type: array - items: *547 + items: *549 examples: - default: &548 + default: &550 value: - issue_field_id: 1 issue_field_name: DRI @@ -92583,9 +93139,9 @@ paths: color: green headers: Link: *66 - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92614,9 +93170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -92688,9 +93244,9 @@ paths: type: array description: The current issue field values for this issue after adding the new values - items: *547 + items: *549 examples: - default: *548 + default: *550 '400': *14 '403': *27 '404': *6 @@ -92726,9 +93282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -92795,9 +93351,9 @@ paths: type: array description: The current issue field values for this issue after setting the new values - items: *547 + items: *549 examples: - default: *548 + default: *550 '400': *14 '403': *27 '404': *6 @@ -92828,9 +93384,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: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *244 responses: '204': @@ -92856,9 +93412,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -92870,7 +93426,7 @@ paths: type: array items: *81 examples: - default: &549 + default: &551 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -92888,9 +93444,9 @@ paths: default: false headers: Link: *66 - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92906,9 +93462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: false content: @@ -92953,10 +93509,10 @@ paths: type: array items: *81 examples: - default: *549 - '301': *341 + default: *551 + '301': *343 '404': *6 - '410': *536 + '410': *538 '422': *15 x-github: githubCloudOnly: false @@ -92973,9 +93529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: false content: @@ -93037,10 +93593,10 @@ paths: type: array items: *81 examples: - default: *549 - '301': *341 + default: *551 + '301': *343 '404': *6 - '410': *536 + '410': *538 '422': *15 x-github: githubCloudOnly: false @@ -93057,15 +93613,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 responses: '204': description: Response - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93084,9 +93640,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - name: name in: path required: true @@ -93110,9 +93666,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *341 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93132,9 +93688,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: false content: @@ -93163,7 +93719,7 @@ paths: '204': description: Response '403': *27 - '410': *536 + '410': *538 '404': *6 '422': *15 x-github: @@ -93181,9 +93737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 responses: '204': description: Response @@ -93213,9 +93769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 responses: '200': description: Response @@ -93223,10 +93779,10 @@ paths: application/json: schema: *82 examples: - default: *543 - '301': *341 + default: *545 + '301': *343 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93243,9 +93799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - 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. @@ -93271,13 +93827,13 @@ paths: application/json: schema: type: array - items: *467 + items: *469 examples: - default: *538 + default: *540 headers: Link: *66 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93295,9 +93851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -93329,16 +93885,16 @@ paths: description: Response content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '201': description: Response content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '422': *15 x-github: githubCloudOnly: false @@ -93360,10 +93916,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *337 - - *338 - - *544 - - *539 + - *339 + - *340 + - *546 + - *541 responses: '204': description: Response @@ -93392,9 +93948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -93418,7 +93974,7 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -93451,9 +94007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -93465,11 +94021,11 @@ paths: type: array items: *82 examples: - default: *546 + default: *548 headers: Link: *66 '404': *6 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93497,9 +94053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -93528,14 +94084,14 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *536 + '410': *538 '422': *15 '404': *6 x-github: @@ -93555,9 +94111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 requestBody: required: true content: @@ -93590,7 +94146,7 @@ paths: application/json: schema: *82 examples: - default: *543 + default: *545 '403': *27 '404': *6 '422': *7 @@ -93612,9 +94168,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *337 - - *338 - - *544 + - *339 + - *340 + - *546 - *17 - *19 responses: @@ -93629,8 +94185,6 @@ paths: description: Timeline Event type: object anyOf: - - *550 - - *551 - *552 - *553 - *554 @@ -93642,6 +94196,8 @@ paths: - *560 - *561 - *562 + - *563 + - *564 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -93698,11 +94254,11 @@ paths: pin: anyOf: - type: 'null' - - *563 + - *565 minimized: anyOf: - type: 'null' - - *564 + - *566 required: - event - actor @@ -93978,7 +94534,7 @@ paths: type: string comments: type: array - items: &594 + items: &596 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -94219,7 +94775,7 @@ paths: type: string comments: type: array - items: *466 + items: *468 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -94339,8 +94895,6 @@ paths: - commit_url - created_at - performed_via_github_app - - *565 - - *566 - *567 - *568 - *569 @@ -94350,6 +94904,8 @@ paths: - *573 - *574 - *575 + - *576 + - *577 examples: default: value: @@ -94506,7 +95062,7 @@ paths: Link: *66 '404': *6 '400': *14 - '410': *536 + '410': *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94523,8 +95079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -94534,7 +95090,7 @@ paths: application/json: schema: type: array - items: &576 + items: &578 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -94602,8 +95158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -94639,9 +95195,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *578 examples: - default: &577 + default: &579 value: id: 1 key: ssh-rsa AAA... @@ -94675,9 +95231,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *337 - - *338 - - &578 + - *339 + - *340 + - &580 name: key_id description: The unique identifier of the key. in: path @@ -94689,9 +95245,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *578 examples: - default: *577 + default: *579 '404': *6 x-github: githubCloudOnly: false @@ -94709,9 +95265,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *337 - - *338 - - *578 + - *339 + - *340 + - *580 responses: '204': description: Response @@ -94731,8 +95287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -94744,7 +95300,7 @@ paths: type: array items: *81 examples: - default: *549 + default: *551 headers: Link: *66 '404': *6 @@ -94765,8 +95321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -94804,7 +95360,7 @@ paths: application/json: schema: *81 examples: - default: &579 + default: &581 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -94836,8 +95392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *337 - - *338 + - *339 + - *340 - name: name in: path required: true @@ -94850,7 +95406,7 @@ paths: application/json: schema: *81 examples: - default: *579 + default: *581 '404': *6 x-github: githubCloudOnly: false @@ -94867,8 +95423,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *337 - - *338 + - *339 + - *340 - name: name in: path required: true @@ -94933,8 +95489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *337 - - *338 + - *339 + - *340 - name: name in: path required: true @@ -94960,8 +95516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -95000,9 +95556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *337 - - *338 - - *441 + - *339 + - *340 + - *443 responses: '200': description: Response @@ -95149,8 +95705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -95215,8 +95771,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -95250,9 +95806,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *469 + schema: *471 examples: - default: *580 + default: *582 '204': description: Response when already merged '404': @@ -95277,8 +95833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *337 - - *338 + - *339 + - *340 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -95375,8 +95931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -95418,7 +95974,7 @@ paths: application/json: schema: *281 examples: - default: &581 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -95477,9 +96033,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *337 - - *338 - - &582 + - *339 + - *340 + - &584 name: milestone_number description: The number that identifies the milestone. in: path @@ -95493,7 +96049,7 @@ paths: application/json: schema: *281 examples: - default: *581 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -95510,9 +96066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *337 - - *338 - - *582 + - *339 + - *340 + - *584 requestBody: required: false content: @@ -95552,7 +96108,7 @@ paths: application/json: schema: *281 examples: - default: *581 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95568,9 +96124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *337 - - *338 - - *582 + - *339 + - *340 + - *584 responses: '204': description: Response @@ -95591,9 +96147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *337 - - *338 - - *582 + - *339 + - *340 + - *584 - *17 - *19 responses: @@ -95605,7 +96161,7 @@ paths: type: array items: *81 examples: - default: *549 + default: *551 headers: Link: *66 x-github: @@ -95624,12 +96180,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *337 - - *338 - - *583 - - *584 - - *87 + - *339 + - *340 - *585 + - *586 + - *87 + - *587 - *17 - *19 responses: @@ -95641,7 +96197,7 @@ paths: type: array items: *107 examples: - default: *586 + default: *588 headers: Link: *66 x-github: @@ -95665,8 +96221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -95724,14 +96280,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: &587 + schema: &589 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -95875,7 +96431,7 @@ paths: - custom_404 - public examples: - default: &588 + default: &590 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -95916,8 +96472,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -95972,9 +96528,9 @@ paths: description: Response content: application/json: - schema: *587 + schema: *589 examples: - default: *588 + default: *590 '422': *15 '409': *52 x-github: @@ -95997,8 +96553,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -96098,8 +96654,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -96125,8 +96681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -96136,7 +96692,7 @@ paths: application/json: schema: type: array - items: &589 + items: &591 title: Page Build description: Page Build type: object @@ -96228,8 +96784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *337 - - *338 + - *339 + - *340 responses: '201': description: Response @@ -96276,16 +96832,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: &590 + default: &592 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -96333,8 +96889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *337 - - *338 + - *339 + - *340 - name: build_id in: path required: true @@ -96345,9 +96901,9 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: - default: *590 + default: *592 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96367,8 +96923,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -96476,9 +97032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *337 - - *338 - - &591 + - *339 + - *340 + - &593 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -96536,9 +97092,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *337 - - *338 - - *591 + - *339 + - *340 + - *593 responses: '204': *59 '404': *6 @@ -96565,8 +97121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -96861,8 +97417,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: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Private vulnerability reporting status @@ -96899,8 +97455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': *59 '422': *14 @@ -96921,8 +97477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': *59 '422': *14 @@ -96944,8 +97500,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -96984,8 +97540,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: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -97047,8 +97603,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *337 - - *338 + - *339 + - *340 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -97108,9 +97664,9 @@ paths: application/json: schema: type: array - items: *473 + items: *475 examples: - default: *592 + default: *594 headers: Link: *66 '304': *35 @@ -97142,8 +97698,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -97210,7 +97766,7 @@ paths: description: Response content: application/json: - schema: &596 + schema: &598 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -97444,7 +98000,7 @@ paths: - review_comment - self author_association: *79 - auto_merge: *593 + auto_merge: *595 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -97546,7 +98102,7 @@ paths: - merged_by - review_comments examples: - default: &597 + default: &599 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -98073,8 +98629,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *337 - - *338 + - *339 + - *340 - name: sort in: query required: false @@ -98103,9 +98659,9 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: &599 + default: &601 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -98182,17 +98738,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '200': description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: &595 + default: &597 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -98267,8 +98823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -98291,9 +98847,9 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: - default: *595 + default: *597 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98309,8 +98865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *337 - - *338 + - *339 + - *340 - *96 responses: '204': @@ -98332,8 +98888,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -98360,9 +98916,9 @@ paths: application/json: schema: type: array - items: *467 + items: *469 examples: - default: *538 + default: *540 headers: Link: *66 '404': *6 @@ -98383,8 +98939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *337 - - *338 + - *339 + - *340 - *96 requestBody: required: true @@ -98417,16 +98973,16 @@ paths: description: Reaction exists content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '201': description: Reaction created content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '422': *15 x-github: githubCloudOnly: false @@ -98448,10 +99004,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *337 - - *338 + - *339 + - *340 - *96 - - *539 + - *541 responses: '204': description: Response @@ -98494,9 +99050,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *337 - - *338 - - &598 + - *339 + - *340 + - &600 name: pull_number description: The number that identifies the pull request. in: path @@ -98509,9 +99065,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '304': *35 '404': *6 '406': @@ -98546,9 +99102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: false content: @@ -98590,9 +99146,9 @@ paths: description: Response content: application/json: - schema: *596 + schema: *598 examples: - default: *597 + default: *599 '422': *15 '403': *27 x-github: @@ -98614,9 +99170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: true content: @@ -98679,7 +99235,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -98687,7 +99243,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '401': *23 '403': *27 '404': *6 @@ -98717,9 +99273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 - *104 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -98740,9 +99296,9 @@ paths: application/json: schema: type: array - items: *594 + items: *596 examples: - default: *599 + default: *601 headers: Link: *66 x-github: @@ -98775,9 +99331,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: true content: @@ -98883,7 +99439,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: example-for-a-multi-line-comment: value: @@ -98971,9 +99527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 - *96 requestBody: required: true @@ -98996,7 +99552,7 @@ paths: description: Response content: application/json: - schema: *594 + schema: *596 examples: default: value: @@ -99082,9 +99638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 - *17 - *19 responses: @@ -99094,9 +99650,9 @@ paths: application/json: schema: type: array - items: *469 + items: *471 examples: - default: *600 + default: *602 headers: Link: *66 x-github: @@ -99126,9 +99682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 - *17 - *19 responses: @@ -99138,7 +99694,7 @@ paths: application/json: schema: type: array - items: *480 + items: *482 examples: default: value: @@ -99176,9 +99732,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 responses: '204': description: Response if pull request has been merged @@ -99201,9 +99757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: false content: @@ -99315,9 +99871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 responses: '200': description: Response @@ -99392,9 +99948,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: false content: @@ -99431,7 +99987,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -99967,9 +100523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: true content: @@ -100003,7 +100559,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -100508,9 +101064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 - *17 - *19 responses: @@ -100520,7 +101076,7 @@ paths: application/json: schema: type: array - items: &601 + items: &603 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -100676,9 +101232,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: false content: @@ -100768,9 +101324,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &603 + default: &605 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100833,10 +101389,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 - - &602 + - *339 + - *340 + - *600 + - &604 name: review_id description: The unique identifier of the review. in: path @@ -100848,9 +101404,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: &604 + default: &606 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -100909,10 +101465,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 - - *602 + - *339 + - *340 + - *600 + - *604 requestBody: required: true content: @@ -100935,7 +101491,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -100997,18 +101553,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 - - *602 + - *339 + - *340 + - *600 + - *604 responses: '200': description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *603 + default: *605 '422': *7 '404': *6 x-github: @@ -101035,10 +101591,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *337 - - *338 - - *598 - - *602 + - *339 + - *340 + - *600 + - *604 - *17 - *19 responses: @@ -101296,10 +101852,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 - - *602 + - *339 + - *340 + - *600 + - *604 requestBody: required: true content: @@ -101328,7 +101884,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: default: value: @@ -101391,10 +101947,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *337 - - *338 - - *598 - - *602 + - *339 + - *340 + - *600 + - *604 requestBody: required: true content: @@ -101429,9 +101985,9 @@ paths: description: Response content: application/json: - schema: *601 + schema: *603 examples: - default: *604 + default: *606 '404': *6 '422': *7 '403': *27 @@ -101453,9 +102009,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *337 - - *338 - - *598 + - *339 + - *340 + - *600 requestBody: required: false content: @@ -101519,8 +102075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *337 - - *338 + - *339 + - *340 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -101533,9 +102089,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: &606 + default: &608 value: type: file encoding: base64 @@ -101577,8 +102133,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *337 - - *338 + - *339 + - *340 - name: dir description: The alternate path to look for a README file in: path @@ -101598,9 +102154,9 @@ paths: description: Response content: application/json: - schema: *605 + schema: *607 examples: - default: *606 + default: *608 '404': *6 '422': *15 x-github: @@ -101622,8 +102178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -101633,7 +102189,7 @@ paths: application/json: schema: type: array - items: *607 + items: *609 examples: default: value: @@ -101727,8 +102283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -101804,9 +102360,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: &611 + default: &613 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -101911,9 +102467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *337 - - *338 - - &609 + - *339 + - *340 + - &611 name: asset_id description: The unique identifier of the asset. in: path @@ -101925,9 +102481,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: &610 + default: &612 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 @@ -101962,7 +102518,7 @@ paths: type: User site_admin: false '404': *6 - '302': *484 + '302': *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101978,9 +102534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *337 - - *338 - - *609 + - *339 + - *340 + - *611 requestBody: required: false content: @@ -102009,9 +102565,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *610 examples: - default: *610 + default: *612 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102027,9 +102583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *337 - - *338 - - *609 + - *339 + - *340 + - *611 responses: '204': description: Response @@ -102054,8 +102610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -102141,16 +102697,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -102168,8 +102724,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *337 - - *338 + - *339 + - *340 - name: tag description: tag parameter in: path @@ -102182,9 +102738,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': *6 x-github: githubCloudOnly: false @@ -102206,9 +102762,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *337 - - *338 - - &612 + - *339 + - *340 + - &614 name: release_id description: The unique identifier of the release. in: path @@ -102222,9 +102778,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: *607 + schema: *609 examples: - default: *611 + default: *613 '401': description: Unauthorized x-github: @@ -102242,9 +102798,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 requestBody: required: false content: @@ -102308,9 +102864,9 @@ paths: description: Response content: application/json: - schema: *607 + schema: *609 examples: - default: *611 + default: *613 '404': description: Not Found if the discussion category name is invalid content: @@ -102331,9 +102887,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 responses: '204': description: Response @@ -102354,9 +102910,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 - *17 - *19 responses: @@ -102366,7 +102922,7 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: default: value: @@ -102447,9 +103003,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: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 - name: name in: query required: true @@ -102475,7 +103031,7 @@ paths: description: Response for successful upload content: application/json: - schema: *608 + schema: *610 examples: response-for-successful-upload: value: @@ -102530,9 +103086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 - 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. @@ -102556,9 +103112,9 @@ paths: application/json: schema: type: array - items: *467 + items: *469 examples: - default: *538 + default: *540 headers: Link: *66 '404': *6 @@ -102579,9 +103135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *337 - - *338 - - *612 + - *339 + - *340 + - *614 requestBody: required: true content: @@ -102611,16 +103167,16 @@ paths: description: Reaction exists content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '201': description: Reaction created content: application/json: - schema: *467 + schema: *469 examples: - default: *468 + default: *470 '422': *15 x-github: githubCloudOnly: false @@ -102642,10 +103198,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *337 - - *338 - - *612 - - *539 + - *339 + - *340 + - *614 + - *541 responses: '204': description: Response @@ -102669,9 +103225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *337 - - *338 - - *403 + - *339 + - *340 + - *405 - *17 - *19 responses: @@ -102688,7 +103244,7 @@ paths: oneOf: - allOf: - *302 - - &613 + - &615 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -102709,70 +103265,70 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *303 - - *613 + - *615 - allOf: - *304 - - *613 + - *615 - allOf: - *305 - - *613 + - *615 - allOf: - - *614 - - *613 + - *616 + - *615 - allOf: - *306 - - *613 + - *615 - allOf: - *307 - - *613 + - *615 - allOf: - *308 - - *613 + - *615 - allOf: - *309 - - *613 + - *615 - allOf: - *310 - - *613 + - *615 - allOf: - *311 - - *613 + - *615 - allOf: - *312 - - *613 + - *615 - allOf: - *313 - - *613 + - *615 - allOf: - *314 - - *613 + - *615 - allOf: - *315 - - *613 + - *615 - allOf: - *320 - - *613 + - *615 - allOf: - *321 - - *613 + - *615 - allOf: - *322 - - *613 + - *615 - allOf: + - *617 - *615 - - *613 - allOf: - *316 - - *613 + - *615 - allOf: - *317 - - *613 + - *615 - allOf: - *318 - - *613 + - *615 - allOf: - *319 - - *613 + - *615 examples: default: value: @@ -102811,8 +103367,8 @@ paths: category: repos subcategory: rules parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 - name: includes_parents @@ -102823,7 +103379,7 @@ paths: schema: type: boolean default: true - - *616 + - *618 responses: '200': description: Response @@ -102878,8 +103434,8 @@ paths: category: repos subcategory: rules parameters: - - *337 - - *338 + - *339 + - *340 requestBody: description: Request body required: true @@ -102908,7 +103464,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *617 + items: *619 required: - name - enforcement @@ -102941,7 +103497,7 @@ paths: application/json: schema: *323 examples: - default: &628 + default: &630 value: id: 42 name: super cool ruleset @@ -102989,13 +103545,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *337 - - *338 - - *618 - - *619 + - *339 + - *340 - *620 - *621 - *622 + - *623 + - *624 - *17 - *19 responses: @@ -103003,9 +103559,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *625 examples: - default: *624 + default: *626 '404': *6 '500': *53 x-github: @@ -103026,17 +103582,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *337 - - *338 - - *625 + - *339 + - *340 + - *627 responses: '200': description: Response content: application/json: - schema: *626 + schema: *628 examples: - default: *627 + default: *629 '404': *6 '500': *53 x-github: @@ -103064,8 +103620,8 @@ paths: category: repos subcategory: rules parameters: - - *337 - - *338 + - *339 + - *340 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103087,7 +103643,7 @@ paths: application/json: schema: *323 examples: - default: *628 + default: *630 '404': *6 '500': *53 put: @@ -103105,8 +103661,8 @@ paths: category: repos subcategory: rules parameters: - - *337 - - *338 + - *339 + - *340 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103140,7 +103696,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *617 + items: *619 examples: default: value: @@ -103170,7 +103726,7 @@ paths: application/json: schema: *323 examples: - default: *628 + default: *630 '404': *6 '422': *15 '500': *53 @@ -103189,8 +103745,8 @@ paths: category: repos subcategory: rules parameters: - - *337 - - *338 + - *339 + - *340 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103213,8 +103769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 - name: ruleset_id @@ -103232,7 +103788,7 @@ paths: type: array items: *326 examples: - default: *629 + default: *631 '404': *6 '500': *53 x-github: @@ -103251,8 +103807,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *337 - - *338 + - *339 + - *340 - name: ruleset_id description: The ID of the ruleset. in: path @@ -103270,7 +103826,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *632 examples: default: value: @@ -103325,21 +103881,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *337 - - *338 - - *631 - - *632 + - *339 + - *340 - *633 - *634 - *635 - *636 - *637 - *638 + - *639 + - *640 - *60 - *19 - *17 - - *639 - - *640 - *641 - *642 - *643 @@ -103347,6 +103901,8 @@ paths: - *645 - *646 - *647 + - *648 + - *649 responses: '200': description: Response @@ -103370,8 +103926,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *648 - resolution: *649 + state: *650 + resolution: *651 resolved_at: type: - string @@ -103477,7 +104033,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *650 + - *652 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -103636,16 +104192,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *337 - - *338 - - *435 - - *644 + - *339 + - *340 + - *437 + - *646 responses: '200': description: Response content: application/json: - schema: &651 + schema: &653 type: object properties: number: *180 @@ -103660,8 +104216,8 @@ paths: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *648 - resolution: *649 + state: *650 + resolution: *651 resolved_at: type: - string @@ -103767,7 +104323,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *650 + - *652 has_more_locations: type: boolean description: A boolean value representing whether or not the token @@ -103790,7 +104346,7 @@ paths: anyOf: - type: 'null' - *4 - metadata: &802 + metadata: &817 type: array description: A list of metadata key/value pairs associated with the secret scanning alert. @@ -103863,9 +104419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 requestBody: required: true content: @@ -103873,8 +104429,8 @@ paths: schema: type: object properties: - state: *648 - resolution: *649 + state: *650 + resolution: *651 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -103922,7 +104478,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *653 examples: default: value: @@ -104024,9 +104580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *337 - - *338 - - *435 + - *339 + - *340 + - *437 - *19 - *17 responses: @@ -104037,7 +104593,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &804 + items: &819 type: object properties: type: @@ -104064,8 +104620,6 @@ paths: - commit details: oneOf: - - *652 - - *653 - *654 - *655 - *656 @@ -104077,6 +104631,8 @@ paths: - *662 - *663 - *664 + - *665 + - *666 examples: default: value: @@ -104146,6 +104702,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: + - *339 + - *340 + - *667 + - *668 + - *669 + - *60 + - *19 + - *17 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *327 + examples: + default: *670 + headers: + Link: *66 + '403': *27 + '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: + - *339 + - *340 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - patterns + properties: + patterns: + type: array + description: The list of custom patterns to create. + items: *671 + examples: + default: *672 + 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: *327 + examples: + default: *673 + '400': *14 + '403': *27 + '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: *674 + 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: + - *339 + - *340 + 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: *675 + 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: *676 + responses: + '204': + description: All patterns deleted successfully. + '400': *14 + '403': *27 + '404': *6 + '412': *329 + "/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: + - *339 + - *340 + - name: pattern_id + in: path + required: true + schema: + type: integer + description: The ID of the custom pattern. + requestBody: + required: true + content: + application/json: + schema: *677 + examples: + default: *678 + responses: + '200': + description: Pattern updated successfully. + content: + application/json: + schema: *327 + examples: + default: *679 + '400': *14 + '403': *27 + '404': *6 + '412': *329 + '422': *15 "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": post: summary: Create a push protection bypass @@ -104162,8 +104933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -104171,14 +104942,14 @@ paths: schema: type: object properties: - reason: &666 + reason: &681 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *665 + placeholder_id: *680 required: - reason - placeholder_id @@ -104195,7 +104966,7 @@ paths: schema: type: object properties: - reason: *666 + reason: *681 expire_at: type: - string @@ -104242,8 +105013,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: - - *337 - - *338 + - *339 + - *340 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -104258,7 +105029,7 @@ paths: properties: incremental_scans: type: array - items: &667 + items: &682 description: Information on a single scan performed by secret scanning on the repository type: object @@ -104291,15 +105062,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *667 + items: *682 backfill_scans: type: array - items: *667 + items: *682 custom_pattern_backfill_scans: type: array items: allOf: - - *667 + - *682 - type: object properties: pattern_name: @@ -104312,7 +105083,7 @@ paths: one of "repository", "organization", or "enterprise" generic_secrets_backfill_scans: type: array - items: *667 + items: *682 examples: default: value: @@ -104377,8 +105148,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *337 - - *338 + - *339 + - *340 - *60 - name: sort description: The property to sort the results by. @@ -104422,9 +105193,9 @@ paths: application/json: schema: type: array - items: *668 + items: *683 examples: - default: *669 + default: *684 '400': *14 '404': *6 x-github: @@ -104447,8 +105218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -104528,7 +105299,7 @@ paths: login: type: string description: The username of the user credited. - type: *329 + type: *331 required: - login - type @@ -104618,9 +105389,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *683 examples: - default: &671 + default: &686 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -104853,8 +105624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -104967,7 +105738,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *683 examples: default: value: @@ -105114,17 +105885,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *337 - - *338 - - *670 + - *339 + - *340 + - *685 responses: '200': description: Response content: application/json: - schema: *668 + schema: *683 examples: - default: *671 + default: *686 '403': *27 '404': *6 x-github: @@ -105148,9 +105919,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *337 - - *338 - - *670 + - *339 + - *340 + - *685 requestBody: required: true content: @@ -105230,7 +106001,7 @@ paths: login: type: string description: The username of the user credited. - type: *329 + type: *331 required: - login - type @@ -105321,10 +106092,10 @@ paths: description: Response content: application/json: - schema: *668 + schema: *683 examples: - default: *671 - add_credit: *671 + default: *686 + add_credit: *686 '403': *27 '404': *6 '422': @@ -105362,9 +106133,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: - - *337 - - *338 - - *670 + - *339 + - *340 + - *685 responses: '202': *37 '400': *14 @@ -105391,17 +106162,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *337 - - *338 - - *670 + - *339 + - *340 + - *685 responses: '202': description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *342 + default: *344 '400': *14 '422': *15 '403': *27 @@ -105427,8 +106198,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -105524,8 +106295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -105534,7 +106305,7 @@ paths: application/json: schema: type: array - items: &672 + items: &687 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -105567,8 +106338,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -105646,8 +106417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -105741,8 +106512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -105896,8 +106667,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -105907,7 +106678,7 @@ paths: application/json: schema: type: array - items: *672 + items: *687 examples: default: value: @@ -105940,8 +106711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *337 - - *338 + - *339 + - *340 - name: sha in: path required: true @@ -105997,7 +106768,7 @@ paths: description: Response content: application/json: - schema: *673 + schema: *688 examples: default: value: @@ -106051,8 +106822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -106084,14 +106855,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &674 + schema: &689 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -106164,8 +106935,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: false content: @@ -106191,7 +106962,7 @@ paths: description: Response content: application/json: - schema: *674 + schema: *689 examples: default: value: @@ -106218,8 +106989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -106239,8 +107010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -106322,8 +107093,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *337 - - *338 + - *339 + - *340 - name: ref in: path required: true @@ -106359,8 +107130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *337 - - *338 + - *339 + - *340 - *17 - *19 responses: @@ -106392,8 +107163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *337 - - *338 + - *339 + - *340 - *19 - *17 responses: @@ -106401,7 +107172,7 @@ paths: description: Response content: application/json: - schema: &675 + schema: &690 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -106413,7 +107184,7 @@ paths: required: - names examples: - default: &676 + default: &691 value: names: - octocat @@ -106436,8 +107207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -106468,9 +107239,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *690 examples: - default: *676 + default: *691 '404': *6 '422': *7 x-github: @@ -106491,9 +107262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *337 - - *338 - - &677 + - *339 + - *340 + - &692 name: per description: The time frame to display results for. in: query @@ -106524,7 +107295,7 @@ paths: - 128 clones: type: array - items: &678 + items: &693 title: Traffic type: object properties: @@ -106611,8 +107382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -106706,8 +107477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *337 - - *338 + - *339 + - *340 responses: '200': description: Response @@ -106770,9 +107541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *337 - - *338 - - *677 + - *339 + - *340 + - *692 responses: '200': description: Response @@ -106793,7 +107564,7 @@ paths: - 3782 views: type: array - items: *678 + items: *693 required: - uniques - count @@ -106870,8 +107641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *337 - - *338 + - *339 + - *340 requestBody: required: true content: @@ -107145,8 +107916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -107169,8 +107940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -107192,8 +107963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -107219,8 +107990,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *337 - - *338 + - *339 + - *340 - name: ref in: path required: true @@ -107312,9 +108083,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *342 + default: *344 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -107566,7 +108337,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &679 + text_matches: &694 title: Search Result Text Matches type: array items: @@ -107729,7 +108500,7 @@ paths: enum: - author-date - committer-date - - &680 + - &695 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 @@ -107798,7 +108569,7 @@ paths: committer: anyOf: - type: 'null' - - *401 + - *403 comment_count: type: integer message: @@ -107817,7 +108588,7 @@ paths: url: type: string format: uri - verification: *520 + verification: *522 required: - author - committer @@ -107832,7 +108603,7 @@ paths: committer: anyOf: - type: 'null' - - *401 + - *403 parents: type: array items: @@ -107849,7 +108620,7 @@ paths: type: number node_id: type: string - text_matches: *679 + text_matches: *694 required: - sha - node_id @@ -108041,7 +108812,7 @@ paths: - interactions - created - updated - - *680 + - *695 - *17 - *19 - name: advanced_search @@ -108155,11 +108926,11 @@ paths: type: - string - 'null' - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: type: string state_reason: @@ -108187,7 +108958,7 @@ paths: - string - 'null' format: date-time - text_matches: *679 + text_matches: *694 pull_request: type: object properties: @@ -108463,7 +109234,7 @@ paths: enum: - created - updated - - *680 + - *695 - *17 - *19 responses: @@ -108508,7 +109279,7 @@ paths: - 'null' score: type: number - text_matches: *679 + text_matches: *694 required: - id - node_id @@ -108593,7 +109364,7 @@ paths: - forks - help-wanted-issues - updated - - *680 + - *695 - *17 - *19 responses: @@ -108839,7 +109610,7 @@ paths: - admin - pull - push - text_matches: *679 + text_matches: *694 temp_clone_token: type: string allow_merge_commit: @@ -109147,7 +109918,7 @@ paths: - string - 'null' format: uri - text_matches: *679 + text_matches: *694 related: type: - array @@ -109340,7 +110111,7 @@ paths: - followers - repositories - joined - - *680 + - *695 - *17 - *19 responses: @@ -109450,7 +110221,7 @@ paths: type: - boolean - 'null' - text_matches: *679 + text_matches: *694 blog: type: - string @@ -109532,7 +110303,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &683 + - &698 name: team_id description: The unique identifier of the team. in: path @@ -109544,9 +110315,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '404': *6 x-github: githubCloudOnly: false @@ -109573,7 +110344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *683 + - *698 requestBody: required: true content: @@ -109637,16 +110408,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '201': description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *334 + default: *336 '404': *6 '422': *15 '403': *27 @@ -109674,7 +110445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *683 + - *698 responses: '204': description: Response @@ -109703,7 +110474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *683 + - *698 - *17 - *19 responses: @@ -109743,7 +110514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *683 + - *698 - name: role description: Filters members returned by their role in the team. in: query @@ -109764,9 +110535,9 @@ paths: application/json: schema: type: array - items: *684 + items: *699 examples: - default: *685 + default: *700 headers: Link: *66 '404': *6 @@ -109794,7 +110565,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *683 + - *698 - *70 responses: '204': @@ -109831,7 +110602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *683 + - *698 - *70 responses: '204': @@ -109871,7 +110642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *683 + - *698 - *70 responses: '204': @@ -109908,16 +110679,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *683 + - *698 - *70 responses: '200': description: Response content: application/json: - schema: *336 + schema: *338 examples: - response-if-user-is-a-team-maintainer: *686 + response-if-user-is-a-team-maintainer: *701 '404': *6 x-github: githubCloudOnly: false @@ -109950,7 +110721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *683 + - *698 - *70 requestBody: required: false @@ -109976,9 +110747,9 @@ paths: description: Response content: application/json: - schema: *336 + schema: *338 examples: - response-if-users-membership-with-team-is-now-pending: *687 + response-if-users-membership-with-team-is-now-pending: *702 '403': description: Forbidden if team synchronization is set up '422': @@ -110012,7 +110783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *683 + - *698 - *70 responses: '204': @@ -110040,7 +110811,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *683 + - *698 - *17 - *19 responses: @@ -110082,15 +110853,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *683 - - *337 - - *338 + - *698 + - *339 + - *340 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *688 + schema: *703 examples: alternative-response-with-extra-repository-information: value: @@ -110241,9 +111012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *683 - - *337 - - *338 + - *698 + - *339 + - *340 requestBody: required: false content: @@ -110293,9 +111064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *683 - - *337 - - *338 + - *698 + - *339 + - *340 responses: '204': description: Response @@ -110320,7 +111091,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *683 + - *698 - *17 - *19 responses: @@ -110332,7 +111103,7 @@ paths: type: array items: *200 examples: - response-if-child-teams-exist: *689 + response-if-child-teams-exist: *704 headers: Link: *66 '404': *6 @@ -110365,7 +111136,7 @@ paths: application/json: schema: oneOf: - - &691 + - &706 title: Private User description: Private User type: object @@ -110615,7 +111386,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *690 + - *705 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -110775,7 +111546,7 @@ paths: description: Response content: application/json: - schema: *691 + schema: *706 examples: default: value: @@ -111121,7 +111892,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '202': description: Response when the codespace creation partially failed but is being retried in the background @@ -111129,7 +111900,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '401': *23 '403': *27 '404': *6 @@ -111173,7 +111944,7 @@ paths: type: integer secrets: type: array - items: &692 + items: &707 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -111215,7 +111986,7 @@ paths: - visibility - selected_repositories_url examples: - default: *460 + default: *462 headers: Link: *66 x-github: @@ -111293,7 +112064,7 @@ paths: description: Response content: application/json: - schema: *692 + schema: *707 examples: default: value: @@ -111591,7 +112362,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '304': *35 '500': *53 '401': *23 @@ -111649,7 +112420,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '401': *23 '403': *27 '404': *6 @@ -111706,7 +112477,7 @@ paths: description: Response content: application/json: - schema: &693 + schema: &708 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -111759,7 +112530,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &694 + default: &709 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -111804,9 +112575,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *708 examples: - default: *694 + default: *709 '404': *6 x-github: githubCloudOnly: false @@ -111843,9 +112614,9 @@ paths: type: integer machines: type: array - items: *459 + items: *461 examples: - default: *695 + default: *710 '304': *35 '500': *53 '401': *23 @@ -111930,11 +112701,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *340 + repository: *342 machine: anyOf: - type: 'null' - - *459 + - *461 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -112739,7 +113510,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '304': *35 '500': *53 '400': *14 @@ -112779,7 +113550,7 @@ paths: application/json: schema: *250 examples: - default: *458 + default: *460 '500': *53 '401': *23 '403': *27 @@ -112811,7 +113582,7 @@ paths: type: array items: *262 examples: - default: &707 + default: &722 value: - id: 197 name: hello_docker @@ -112912,7 +113683,7 @@ paths: application/json: schema: type: array - items: &696 + items: &711 title: Email description: Email type: object @@ -112982,9 +113753,9 @@ paths: application/json: schema: type: array - items: *696 + items: *711 examples: - default: &709 + default: &724 value: - email: octocat@github.com verified: true @@ -113061,7 +113832,7 @@ paths: application/json: schema: type: array - items: *696 + items: *711 examples: default: value: @@ -113319,7 +114090,7 @@ paths: application/json: schema: type: array - items: &697 + items: &712 title: GPG Key description: A unique encryption key type: object @@ -113464,7 +114235,7 @@ paths: - subkeys - revoked examples: - default: &726 + default: &741 value: - id: 3 name: Octocat's GPG Key @@ -113549,9 +114320,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: &698 + default: &713 value: id: 3 name: Octocat's GPG Key @@ -113608,7 +114379,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &699 + - &714 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -113620,9 +114391,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *712 examples: - default: *698 + default: *713 '404': *6 '304': *35 '403': *27 @@ -113645,7 +114416,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *699 + - *714 responses: '204': description: Response @@ -113962,7 +114733,7 @@ paths: required: true content: application/json: - schema: *531 + schema: *533 examples: default: value: @@ -114112,7 +114883,7 @@ paths: application/json: schema: type: array - items: &700 + items: &715 title: Key description: Key type: object @@ -114215,9 +114986,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *715 examples: - default: &701 + default: &716 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -114250,15 +115021,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *578 + - *580 responses: '200': description: Response content: application/json: - schema: *700 + schema: *715 examples: - default: *701 + default: *716 '404': *6 '304': *35 '403': *27 @@ -114281,7 +115052,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *578 + - *580 responses: '204': description: Response @@ -114314,7 +115085,7 @@ paths: application/json: schema: type: array - items: &702 + items: &717 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -114393,7 +115164,7 @@ paths: - account - plan examples: - default: &703 + default: &718 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -114455,9 +115226,9 @@ paths: application/json: schema: type: array - items: *702 + items: *717 examples: - default: *703 + default: *718 headers: Link: *66 '304': *35 @@ -114700,7 +115471,7 @@ paths: application/json: schema: *254 examples: - default: &704 + default: &719 value: url: https://api.github.com/orgs/octocat/memberships/defunkt state: active @@ -114749,7 +115520,7 @@ paths: application/json: schema: *254 examples: - default: *704 + default: *719 '403': *27 '404': *6 '422': *15 @@ -115483,7 +116254,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *257 - - *705 + - *720 responses: '204': description: Response @@ -115598,7 +116369,7 @@ paths: - docker - nuget - container - - *706 + - *721 - *19 - *17 responses: @@ -115610,8 +116381,8 @@ paths: type: array items: *262 examples: - default: *707 - '400': *708 + default: *722 + '400': *723 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -115640,7 +116411,7 @@ paths: application/json: schema: *262 examples: - default: &727 + default: &742 value: id: 40201 name: octo-name @@ -116002,9 +116773,9 @@ paths: application/json: schema: type: array - items: *696 + items: *711 examples: - default: *709 + default: *724 headers: Link: *66 '304': *35 @@ -116117,7 +116888,7 @@ paths: type: array items: *78 examples: - default: &716 + default: &731 summary: Default response value: - id: 1296269 @@ -116435,9 +117206,9 @@ paths: description: Response content: application/json: - schema: *340 + schema: *342 examples: - default: *342 + default: *344 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -116475,9 +117246,9 @@ paths: application/json: schema: type: array - items: *534 + items: *536 examples: - default: *710 + default: *725 headers: Link: *66 '304': *35 @@ -116556,7 +117327,7 @@ paths: application/json: schema: type: array - items: &711 + items: &726 title: Social account description: Social media account type: object @@ -116573,7 +117344,7 @@ paths: - provider - url examples: - default: &712 + default: &727 value: - provider: twitter url: https://twitter.com/github @@ -116636,9 +117407,9 @@ paths: application/json: schema: type: array - items: *711 + items: *726 examples: - default: *712 + default: *727 '422': *15 '304': *35 '404': *6 @@ -116726,7 +117497,7 @@ paths: application/json: schema: type: array - items: &713 + items: &728 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -116746,7 +117517,7 @@ paths: - title - created_at examples: - default: &744 + default: &759 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116811,9 +117582,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *728 examples: - default: &714 + default: &729 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -116843,7 +117614,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: - - &715 + - &730 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -116855,9 +117626,9 @@ paths: description: Response content: application/json: - schema: *713 + schema: *728 examples: - default: *714 + default: *729 '404': *6 '304': *35 '403': *27 @@ -116880,7 +117651,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: - - *715 + - *730 responses: '204': description: Response @@ -116909,7 +117680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &745 + - &760 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 @@ -116934,11 +117705,11 @@ paths: type: array items: *78 examples: - default-response: *716 + default-response: *731 application/vnd.github.v3.star+json: schema: type: array - items: &746 + items: &761 title: Starred Repository description: Starred Repository type: object @@ -117094,8 +117865,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: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response if this repository is starred by you @@ -117123,8 +117894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -117148,8 +117919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *337 - - *338 + - *339 + - *340 responses: '204': description: Response @@ -117221,7 +117992,7 @@ paths: application/json: schema: type: array - items: *333 + items: *335 examples: default: value: @@ -117307,10 +118078,10 @@ paths: application/json: schema: oneOf: - - *691 - - *690 + - *706 + - *705 examples: - default-response: &720 + default-response: &735 summary: Default response value: login: octocat @@ -117345,7 +118116,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &721 + response-with-git-hub-plan-information: &736 summary: Response with GitHub plan information value: login: octocat @@ -117402,7 +118173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project parameters: - - &718 + - &733 name: user_id description: The unique identifier of the user. in: path @@ -117468,7 +118239,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *717 + - *732 - *17 responses: '200': @@ -117503,7 +118274,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project parameters: - - *718 + - *733 - *280 requestBody: required: true @@ -117578,7 +118349,7 @@ paths: description: Response for creating a view in a user-owned project. content: application/json: - schema: *719 + schema: *734 examples: table_view: summary: Response for creating a table view @@ -117630,11 +118401,11 @@ paths: application/json: schema: oneOf: - - *691 - - *690 + - *706 + - *705 examples: - default-response: *720 - response-with-git-hub-plan-information: *721 + default-response: *735 + response-with-git-hub-plan-information: *736 '404': *6 x-github: githubCloudOnly: false @@ -117684,8 +118455,8 @@ paths: required: - subject_digests examples: - default: *722 - withPredicateType: *723 + default: *737 + withPredicateType: *738 responses: '200': description: Response @@ -117739,7 +118510,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *724 + default: *739 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -117944,7 +118715,7 @@ paths: initiator: type: string examples: - default: *397 + default: *399 '201': description: Response content: @@ -118228,7 +118999,7 @@ paths: application/json: schema: *196 examples: - default: &725 + default: &740 summary: Example response for a user copilot space value: id: 42 @@ -118329,7 +119100,7 @@ paths: application/json: schema: *196 examples: - default: *725 + default: *740 '403': *27 '404': *6 x-github: @@ -118455,7 +119226,7 @@ paths: application/json: schema: *196 examples: - default: *725 + default: *740 '403': *27 '404': *6 '422': *15 @@ -119223,7 +119994,7 @@ paths: type: array items: *262 examples: - default: *707 + default: *722 '403': *27 '401': *23 x-github: @@ -119607,9 +120378,9 @@ paths: application/json: schema: type: array - items: *697 + items: *712 examples: - default: *726 + default: *741 headers: Link: *66 x-github: @@ -119713,7 +120484,7 @@ paths: application/json: schema: *20 examples: - default: *530 + default: *532 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119838,7 +120609,7 @@ paths: - docker - nuget - container - - *706 + - *721 - *70 - *19 - *17 @@ -119851,10 +120622,10 @@ paths: type: array items: *262 examples: - default: *707 + default: *722 '403': *27 '401': *23 - '400': *708 + '400': *723 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119884,7 +120655,7 @@ paths: application/json: schema: *262 examples: - default: *727 + default: *742 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120233,7 +121004,7 @@ paths: type: array items: *283 examples: - default: *728 + default: *743 headers: Link: *66 '304': *35 @@ -120293,7 +121064,7 @@ paths: description: The options available for single select fields. At least one option must be provided when creating a single select field. - items: *729 + items: *744 required: - name - data_type @@ -120309,7 +121080,7 @@ paths: description: The field's data type. enum: - iteration - iteration_configuration: *730 + iteration_configuration: *745 required: - name - data_type @@ -120331,8 +121102,8 @@ paths: value: name: Due date data_type: date - single_select_field: *731 - iteration_field: *732 + single_select_field: *746 + iteration_field: *747 responses: '201': description: Response @@ -120340,11 +121111,11 @@ paths: application/json: schema: *283 examples: - text_field: *733 - number_field: *734 - date_field: *735 - single_select_field: *736 - iteration_field: *737 + text_field: *748 + number_field: *749 + date_field: *750 + single_select_field: *751 + iteration_field: *752 '304': *35 '403': *27 '401': *23 @@ -120366,7 +121137,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *280 - - *738 + - *753 - *70 responses: '200': @@ -120375,7 +121146,7 @@ paths: application/json: schema: *283 examples: - default: *739 + default: *754 headers: Link: *66 '304': *35 @@ -120732,7 +121503,7 @@ paths: parameters: - *280 - *70 - - *740 + - *755 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the @@ -121271,7 +122042,7 @@ paths: parameters: - *70 - *116 - - *741 + - *756 - *118 responses: '200': @@ -121370,9 +122141,9 @@ paths: - *116 - *117 - *118 - - *742 + - *757 - *121 - - *743 + - *758 responses: '200': description: Response when getting a billing usage summary @@ -121506,9 +122277,9 @@ paths: application/json: schema: type: array - items: *711 + items: *726 examples: - default: *712 + default: *727 headers: Link: *66 x-github: @@ -121538,9 +122309,9 @@ paths: application/json: schema: type: array - items: *713 + items: *728 examples: - default: *744 + default: *759 headers: Link: *66 x-github: @@ -121565,7 +122336,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *70 - - *745 + - *760 - *60 - *17 - *19 @@ -121577,11 +122348,11 @@ paths: schema: anyOf: - type: array - items: *746 + items: *761 - type: array items: *78 examples: - default-response: *716 + default-response: *731 headers: Link: *66 x-github: @@ -121741,7 +122512,7 @@ webhooks: type: string enum: - disabled - enterprise: &747 + enterprise: &762 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121810,7 +122581,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &748 + installation: &763 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121831,7 +122602,7 @@ webhooks: required: - id - node_id - organization: &749 + organization: &764 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121904,7 +122675,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &750 + repository: &765 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -122830,10 +123601,10 @@ webhooks: type: string enum: - enabled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -122909,11 +123680,11 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: &751 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + rule: &766 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) @@ -123136,11 +123907,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + rule: *766 sender: *4 required: - action @@ -123328,11 +124099,11 @@ webhooks: - everyone required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - rule: *751 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + rule: *766 sender: *4 required: - action @@ -123416,7 +124187,7 @@ webhooks: type: string enum: - completed - check_run: &753 + check_run: &768 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123526,7 +124297,7 @@ webhooks: - examples: - neutral - deployment: *752 + deployment: *767 details_url: type: string examples: @@ -123624,10 +124395,10 @@ webhooks: - output - app - pull_requests - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + installation: *763 + enterprise: *762 + organization: *764 + repository: *765 sender: *4 required: - check_run @@ -124018,11 +124789,11 @@ webhooks: type: string enum: - created - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *768 + installation: *763 + enterprise: *762 + organization: *764 + repository: *765 sender: *4 required: - check_run @@ -124416,11 +125187,11 @@ webhooks: type: string enum: - requested_action - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *768 + installation: *763 + enterprise: *762 + organization: *764 + repository: *765 requested_action: description: The action requested by the user. type: object @@ -124823,11 +125594,11 @@ webhooks: type: string enum: - rerequested - check_run: *753 - installation: *748 - enterprise: *747 - organization: *749 - repository: *750 + check_run: *768 + installation: *763 + enterprise: *762 + organization: *764 + repository: *765 sender: *4 required: - check_run @@ -125812,10 +126583,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -126529,10 +127300,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -127240,10 +128011,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -127412,7 +128183,7 @@ webhooks: required: - login - id - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -127564,20 +128335,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &754 + commit_oid: &769 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: *747 - installation: *748 - organization: *749 - ref: &755 + enterprise: *762 + installation: *763 + organization: *764 + ref: &770 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: *750 + repository: *765 sender: *4 required: - action @@ -127744,7 +128515,7 @@ webhooks: required: - login - id - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -127985,12 +128756,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *769 + enterprise: *762 + installation: *763 + organization: *764 + ref: *770 + repository: *765 sender: *4 required: - action @@ -128088,7 +128859,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128273,12 +129044,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *769 + enterprise: *762 + installation: *763 + organization: *764 + ref: *770 + repository: *765 sender: *4 required: - action @@ -128447,7 +129218,7 @@ webhooks: required: - login - id - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -128624,12 +129395,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *769 + enterprise: *762 + installation: *763 + organization: *764 + ref: *770 + repository: *765 sender: *4 required: - action @@ -128730,7 +129501,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128919,9 +129690,9 @@ webhooks: type: - string - 'null' - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -128929,7 +129700,7 @@ webhooks: type: - string - 'null' - repository: *750 + repository: *765 sender: *4 required: - action @@ -129028,7 +129799,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129175,12 +129946,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *754 - enterprise: *747 - installation: *748 - organization: *749 - ref: *755 - repository: *750 + commit_oid: *769 + enterprise: *762 + installation: *763 + organization: *764 + ref: *770 + repository: *765 sender: *4 required: - action @@ -129349,7 +130120,7 @@ webhooks: required: - login - id - dismissed_comment: *430 + dismissed_comment: *432 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -129501,10 +130272,10 @@ webhooks: - dismissed_reason - rule - tool - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -129764,10 +130535,10 @@ webhooks: - updated_at - author_association - body - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -129848,18 +130619,18 @@ webhooks: type: - string - 'null' - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *749 - pusher_type: &756 + organization: *764 + pusher_type: &771 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &757 + ref: &772 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -129869,7 +130640,7 @@ webhooks: enum: - tag - branch - repository: *750 + repository: *765 sender: *4 required: - ref @@ -129952,9 +130723,9 @@ webhooks: enum: - created definition: *291 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 sender: *4 required: - action @@ -130039,9 +130810,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 sender: *4 required: - action @@ -130119,9 +130890,9 @@ webhooks: enum: - promote_to_enterprise definition: *291 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 sender: *4 required: - action @@ -130199,9 +130970,9 @@ webhooks: enum: - updated definition: *291 - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 sender: *4 required: - action @@ -130278,10 +131049,10 @@ webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - repository: *750 - organization: *749 + enterprise: *762 + installation: *763 + repository: *765 + organization: *764 sender: *4 new_property_values: type: array @@ -130366,18 +131137,18 @@ webhooks: title: delete event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - pusher_type: *756 - ref: *757 + enterprise: *762 + installation: *763 + organization: *764 + pusher_type: *771 + ref: *772 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *750 + repository: *765 sender: *4 required: - ref @@ -130457,11 +131228,11 @@ webhooks: type: string enum: - assignees_changed - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130541,11 +131312,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130626,11 +131397,11 @@ webhooks: type: string enum: - auto_reopened - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130711,11 +131482,11 @@ webhooks: type: string enum: - created - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130794,11 +131565,11 @@ webhooks: type: string enum: - dismissed - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130877,11 +131648,11 @@ webhooks: type: string enum: - fixed - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -130961,11 +131732,11 @@ webhooks: type: string enum: - reintroduced - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -131044,11 +131815,11 @@ webhooks: type: string enum: - reopened - alert: *490 - installation: *748 - organization: *749 - enterprise: *747 - repository: *750 + alert: *492 + installation: *763 + organization: *764 + enterprise: *762 + repository: *765 sender: *4 required: - action @@ -131125,9 +131896,9 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - key: &758 + enterprise: *762 + installation: *763 + key: &773 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131165,8 +131936,8 @@ webhooks: - verified - created_at - read_only - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -131243,11 +132014,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - key: *758 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + key: *773 + organization: *764 + repository: *765 sender: *4 required: - action @@ -131814,12 +132585,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - workflow: &762 + workflow: &777 title: Workflow type: - object @@ -132570,13 +133341,13 @@ webhooks: deployment: anyOf: - type: 'null' - - *497 + - *499 pull_requests: type: array - items: *596 - repository: *750 - organization: *749 - installation: *748 + items: *598 + repository: *765 + organization: *764 + installation: *763 sender: *4 responses: '200': @@ -132647,7 +133418,7 @@ webhooks: type: string enum: - approved - approver: &759 + approver: &774 type: object properties: avatar_url: @@ -132690,11 +133461,11 @@ webhooks: type: string comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: &760 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + reviewers: &775 type: array items: type: object @@ -132775,7 +133546,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &761 + workflow_job_run: &776 type: object properties: conclusion: @@ -133521,18 +134292,18 @@ webhooks: type: string enum: - rejected - approver: *759 + approver: *774 comment: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - reviewers: *760 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + reviewers: *775 sender: *4 since: type: string - workflow_job_run: *761 + workflow_job_run: *776 workflow_job_runs: type: array items: @@ -134249,13 +135020,13 @@ webhooks: type: string enum: - requested - enterprise: *747 + enterprise: *762 environment: type: string - installation: *748 - organization: *749 - repository: *750 - requestor: &767 + installation: *763 + organization: *764 + repository: *765 + requestor: &782 title: User type: - object @@ -136188,12 +136959,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - workflow: *762 + workflow: *777 workflow_run: title: Deployment Workflow Run type: @@ -136884,7 +137655,7 @@ webhooks: type: string enum: - answered - answer: &765 + answer: &780 type: object properties: author_association: @@ -137044,11 +137815,11 @@ webhooks: - created_at - updated_at - body - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137175,11 +137946,11 @@ webhooks: - from required: - category - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137262,11 +138033,11 @@ webhooks: type: string enum: - closed - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137348,7 +138119,7 @@ webhooks: type: string enum: - created - comment: &764 + comment: &779 type: object properties: author_association: @@ -137508,11 +138279,11 @@ webhooks: - updated_at - body - reactions - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137595,12 +138366,12 @@ webhooks: type: string enum: - deleted - comment: *764 - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *779 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137695,12 +138466,12 @@ webhooks: - from required: - body - comment: *764 - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + comment: *779 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137784,11 +138555,11 @@ webhooks: type: string enum: - created - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137870,11 +138641,11 @@ webhooks: type: string enum: - deleted - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -137974,11 +138745,11 @@ webhooks: type: string required: - from - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138060,10 +138831,10 @@ webhooks: type: string enum: - labeled - discussion: *763 - enterprise: *747 - installation: *748 - label: &766 + discussion: *778 + enterprise: *762 + installation: *763 + label: &781 title: Label type: object properties: @@ -138096,8 +138867,8 @@ webhooks: - color - default - description - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138180,11 +138951,11 @@ webhooks: type: string enum: - locked - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138266,11 +139037,11 @@ webhooks: type: string enum: - pinned - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138352,11 +139123,11 @@ webhooks: type: string enum: - reopened - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138441,16 +139212,16 @@ webhooks: changes: type: object properties: - new_discussion: *763 - new_repository: *750 + new_discussion: *778 + new_repository: *765 required: - new_discussion - new_repository - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138533,10 +139304,10 @@ webhooks: type: string enum: - unanswered - discussion: *763 - old_answer: *765 - organization: *749 - repository: *750 + discussion: *778 + old_answer: *780 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138618,12 +139389,12 @@ webhooks: type: string enum: - unlabeled - discussion: *763 - enterprise: *747 - installation: *748 - label: *766 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138706,11 +139477,11 @@ webhooks: type: string enum: - unlocked - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138792,11 +139563,11 @@ webhooks: type: string enum: - unpinned - discussion: *763 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + discussion: *778 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -138869,7 +139640,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *747 + enterprise: *762 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -139547,9 +140318,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - forkee @@ -139695,9 +140466,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pages: description: The pages that were updated. type: array @@ -139735,7 +140506,7 @@ webhooks: - action - sha - html_url - repository: *750 + repository: *765 sender: *4 required: - pages @@ -139811,10 +140582,10 @@ webhooks: type: string enum: - created - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories: &768 + organization: *764 + repositories: &783 description: An array of repository objects that the installation can access. type: array @@ -139840,8 +140611,8 @@ webhooks: - name - full_name - private - repository: *750 - requester: *767 + repository: *765 + requester: *782 sender: *4 required: - action @@ -139916,11 +140687,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories: *768 - repository: *750 + organization: *764 + repositories: *783 + repository: *765 requester: type: - 'null' @@ -139997,11 +140768,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories: *768 - repository: *750 + organization: *764 + repositories: *783 + repository: *765 requester: type: - 'null' @@ -140078,10 +140849,10 @@ webhooks: type: string enum: - added - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories_added: &769 + organization: *764 + repositories_added: &784 description: An array of repository objects, which were added to the installation. type: array @@ -140127,15 +140898,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *750 - repository_selection: &770 + repository: *765 + repository_selection: &785 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *767 + requester: *782 sender: *4 required: - action @@ -140214,10 +140985,10 @@ webhooks: type: string enum: - removed - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories_added: *769 + organization: *764 + repositories_added: *784 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140244,9 +141015,9 @@ webhooks: - name - full_name - private - repository: *750 - repository_selection: *770 - requester: *767 + repository: *765 + repository_selection: *785 + requester: *782 sender: *4 required: - action @@ -140325,11 +141096,11 @@ webhooks: type: string enum: - suspend - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories: *768 - repository: *750 + organization: *764 + repositories: *783 + repository: *765 requester: type: - 'null' @@ -140511,10 +141282,10 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 target_type: type: string @@ -140593,11 +141364,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *747 + enterprise: *762 installation: *20 - organization: *749 - repositories: *768 - repository: *750 + organization: *764 + repositories: *783 + repository: *765 requester: type: - 'null' @@ -140763,11 +141534,11 @@ webhooks: pin: anyOf: - type: 'null' - - *563 + - *565 minimized: anyOf: - type: 'null' - - *564 + - *566 user: title: User type: @@ -140853,8 +141624,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -141666,8 +142437,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142028,8 +142799,8 @@ webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -142109,7 +142880,7 @@ webhooks: type: string enum: - deleted - comment: &771 + comment: &786 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -142266,11 +143037,11 @@ webhooks: pin: anyOf: - type: 'null' - - *563 + - *565 minimized: anyOf: - type: 'null' - - *564 + - *566 required: - url - html_url @@ -142284,8 +143055,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -143093,8 +143864,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143457,8 +144228,8 @@ webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -143538,7 +144309,7 @@ webhooks: type: string enum: - edited - changes: &795 + changes: &810 description: The changes to the comment. type: object properties: @@ -143550,9 +144321,9 @@ webhooks: type: string required: - from - comment: *771 - enterprise: *747 - installation: *748 + comment: *786 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -144363,8 +145134,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144725,8 +145496,8 @@ webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -144807,9 +145578,9 @@ webhooks: type: string enum: - pinned - comment: *771 - enterprise: *747 - installation: *748 + comment: *786 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -145622,8 +146393,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145986,8 +146757,8 @@ webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -146067,9 +146838,9 @@ webhooks: type: string enum: - unpinned - comment: *771 - enterprise: *747 - installation: *748 + comment: *786 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -146882,8 +147653,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147246,8 +148017,8 @@ webhooks: - state - locked - assignee - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -147336,9 +148107,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -147427,9 +148198,9 @@ webhooks: type: number blocking_issue: *82 blocking_issue_repo: *78 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -147517,9 +148288,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -147608,9 +148379,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -147690,10 +148461,10 @@ webhooks: type: string enum: - assigned - assignee: *767 - enterprise: *747 - installation: *748 - issue: &772 + assignee: *782 + enterprise: *762 + installation: *763 + issue: &787 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -148504,11 +149275,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148628,8 +149399,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -148709,8 +149480,8 @@ webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -149526,11 +150297,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149793,8 +150564,8 @@ webhooks: required: - state - closed_at - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -149873,8 +150644,8 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -150681,11 +151452,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150804,8 +151575,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -150884,8 +151655,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -151715,11 +152486,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151817,7 +152588,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &773 + milestone: &788 title: Milestone description: A collection of related issues and pull requests. type: object @@ -151960,8 +152731,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -152060,8 +152831,8 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -152872,11 +153643,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152996,9 +153767,9 @@ webhooks: - active_lock_reason - body - reactions - label: *766 - organization: *749 - repository: *750 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -153078,9 +153849,9 @@ webhooks: type: string enum: - field_added - enterprise: *747 - installation: *748 - issue: *772 + enterprise: *762 + installation: *763 + issue: *787 issue_field: type: object description: The issue field whose value was set or updated on the @@ -153246,8 +154017,8 @@ webhooks: - id required: - from - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -153327,9 +154098,9 @@ webhooks: type: string enum: - field_removed - enterprise: *747 - installation: *748 - issue: *772 + enterprise: *762 + installation: *763 + issue: *787 issue_field: type: object description: The issue field whose value was cleared from the issue. @@ -153416,8 +154187,8 @@ webhooks: - 'null' required: - id - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -153497,8 +154268,8 @@ webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -154308,11 +155079,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154432,9 +155203,9 @@ webhooks: - active_lock_reason - body - reactions - label: *766 - organization: *749 - repository: *750 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -154514,8 +155285,8 @@ webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -155350,11 +156121,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155451,8 +156222,8 @@ webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -155531,8 +156302,8 @@ webhooks: type: string enum: - milestoned - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -156361,11 +157132,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156462,9 +157233,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *773 - organization: *749 - repository: *750 + milestone: *788 + organization: *764 + repository: *765 sender: *4 required: - action @@ -157351,11 +158122,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157947,8 +158718,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -158755,11 +159526,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158882,8 +159653,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -158963,9 +159734,9 @@ webhooks: type: string enum: - pinned - enterprise: *747 - installation: *748 - issue: &774 + enterprise: *762 + installation: *763 + issue: &789 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -159770,11 +160541,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159893,8 +160664,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -159973,8 +160744,8 @@ webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -160807,11 +161578,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160909,8 +161680,8 @@ webhooks: user_view_type: type: string type: *245 - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -161798,11 +162569,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162412,11 +163183,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *747 - installation: *748 - issue: *774 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + issue: *789 + organization: *764 + repository: *765 sender: *4 required: - action @@ -162496,12 +163267,12 @@ webhooks: type: string enum: - typed - enterprise: *747 - installation: *748 - issue: *772 + enterprise: *762 + installation: *763 + issue: *787 type: *245 - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -162582,7 +163353,7 @@ webhooks: type: string enum: - unassigned - assignee: &798 + assignee: &813 title: User type: - object @@ -162654,11 +163425,11 @@ webhooks: required: - login - id - enterprise: *747 - installation: *748 - issue: *772 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + issue: *787 + organization: *764 + repository: *765 sender: *4 required: - action @@ -162737,12 +163508,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - issue: *772 - label: *766 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + issue: *787 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -162822,8 +163593,8 @@ webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -163656,11 +164427,11 @@ webhooks: anyOf: - type: 'null' - *83 - sub_issues_summary: *681 - issue_dependencies_summary: *682 + sub_issues_summary: *696 + issue_dependencies_summary: *697 issue_field_values: type: array - items: *547 + items: *549 state: description: State of the issue; either 'open' or 'closed' type: string @@ -163757,8 +164528,8 @@ webhooks: format: uri user_view_type: type: string - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -163838,11 +164609,11 @@ webhooks: type: string enum: - unpinned - enterprise: *747 - installation: *748 - issue: *774 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + issue: *789 + organization: *764 + repository: *765 sender: *4 required: - action @@ -163921,12 +164692,12 @@ webhooks: type: string enum: - untyped - enterprise: *747 - installation: *748 - issue: *772 + enterprise: *762 + installation: *763 + issue: *787 type: *245 - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -164006,11 +164777,11 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - label: *766 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -164088,11 +164859,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - label: *766 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -164202,11 +164973,11 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - label: *766 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + label: *781 + organization: *764 + repository: *765 sender: *4 required: - action @@ -164288,9 +165059,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: &775 + enterprise: *762 + installation: *763 + marketplace_purchase: &790 title: Marketplace Purchase type: object required: @@ -164378,8 +165149,8 @@ webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: &776 + organization: *764 + previous_marketplace_purchase: &791 title: Marketplace Purchase type: object properties: @@ -164463,7 +165234,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *765 sender: *4 required: - action @@ -164543,10 +165314,10 @@ webhooks: - changed effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *775 - organization: *749 + enterprise: *762 + installation: *763 + marketplace_purchase: *790 + organization: *764 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164634,7 +165405,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *765 sender: *4 required: - action @@ -164716,10 +165487,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *775 - organization: *749 + enterprise: *762 + installation: *763 + marketplace_purchase: *790 + organization: *764 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -164805,7 +165576,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *750 + repository: *765 sender: *4 required: - action @@ -164886,8 +165657,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 marketplace_purchase: title: Marketplace Purchase type: object @@ -164973,9 +165744,9 @@ webhooks: type: integer unit_count: type: integer - organization: *749 - previous_marketplace_purchase: *776 - repository: *750 + organization: *764 + previous_marketplace_purchase: *791 + repository: *765 sender: *4 required: - action @@ -165055,12 +165826,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *747 - installation: *748 - marketplace_purchase: *775 - organization: *749 - previous_marketplace_purchase: *776 - repository: *750 + enterprise: *762 + installation: *763 + marketplace_purchase: *790 + organization: *764 + previous_marketplace_purchase: *791 + repository: *765 sender: *4 required: - action @@ -165162,11 +165933,11 @@ webhooks: type: string required: - to - enterprise: *747 - installation: *748 - member: *767 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + member: *782 + organization: *764 + repository: *765 sender: *4 required: - action @@ -165268,11 +166039,11 @@ webhooks: type: - string - 'null' - enterprise: *747 - installation: *748 - member: *767 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + member: *782 + organization: *764 + repository: *765 sender: *4 required: - action @@ -165351,11 +166122,11 @@ webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *767 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + member: *782 + organization: *764 + repository: *765 sender: *4 required: - action @@ -165433,11 +166204,11 @@ webhooks: type: string enum: - added - enterprise: *747 - installation: *748 - member: *767 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + member: *782 + organization: *764 + repository: *765 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165515,7 +166286,7 @@ webhooks: required: - login - id - team: &777 + team: &792 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -165745,11 +166516,11 @@ webhooks: type: string enum: - removed - enterprise: *747 - installation: *748 - member: *767 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + member: *782 + organization: *764 + repository: *765 scope: description: The scope of the membership. Currently, can only be `team`. @@ -165828,7 +166599,7 @@ webhooks: required: - login - id - team: *777 + team: *792 required: - action - scope @@ -165910,8 +166681,8 @@ webhooks: type: string enum: - checks_requested - installation: *748 - merge_group: &778 + installation: *763 + merge_group: &793 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -165930,15 +166701,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *417 + head_commit: *419 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166024,10 +166795,10 @@ webhooks: - merged - invalidated - dequeued - installation: *748 - merge_group: *778 - organization: *749 - repository: *750 + installation: *763 + merge_group: *793 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166100,7 +166871,7 @@ webhooks: type: string enum: - deleted - enterprise: *747 + enterprise: *762 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -166209,12 +166980,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *748 - organization: *749 + installation: *763 + organization: *764 repository: anyOf: - type: 'null' - - *750 + - *765 sender: *4 required: - action @@ -166294,11 +167065,11 @@ webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - milestone: *773 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + milestone: *788 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166377,9 +167148,9 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - milestone: &779 + enterprise: *762 + installation: *763 + milestone: &794 title: Milestone description: A collection of related issues and pull requests. type: object @@ -166521,8 +167292,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166601,11 +167372,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - milestone: *773 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + milestone: *788 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166715,11 +167486,11 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - milestone: *773 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + milestone: *788 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166799,11 +167570,11 @@ webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - milestone: *779 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + milestone: *794 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166882,11 +167653,11 @@ webhooks: type: string enum: - blocked - blocked_user: *767 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *782 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -166965,11 +167736,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *767 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + blocked_user: *782 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -167048,9 +167819,9 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - membership: &780 + enterprise: *762 + installation: *763 + membership: &795 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -167160,8 +167931,8 @@ webhooks: - role - organization_url - user - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 required: - action @@ -167239,11 +168010,11 @@ webhooks: type: string enum: - member_added - enterprise: *747 - installation: *748 - membership: *780 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + membership: *795 + organization: *764 + repository: *765 sender: *4 required: - action @@ -167322,8 +168093,8 @@ webhooks: type: string enum: - member_invited - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -167445,10 +168216,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 - user: *767 + user: *782 required: - action - invitation @@ -167526,11 +168297,11 @@ webhooks: type: string enum: - member_removed - enterprise: *747 - installation: *748 - membership: *780 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + membership: *795 + organization: *764 + repository: *765 sender: *4 required: - action @@ -167617,11 +168388,11 @@ webhooks: properties: from: type: string - enterprise: *747 - installation: *748 - membership: *780 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + membership: *795 + organization: *764 + repository: *765 sender: *4 required: - action @@ -167698,9 +168469,9 @@ webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 package: description: Information about the package. type: object @@ -168223,7 +168994,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &781 + items: &796 title: Ruby Gems metadata type: object properties: @@ -168320,7 +169091,7 @@ webhooks: - owner - package_version - registry - repository: *750 + repository: *765 sender: *4 required: - action @@ -168396,9 +169167,9 @@ webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 package: description: Information about the package. type: object @@ -168760,7 +169531,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *781 + items: *796 source_url: type: string format: uri @@ -168831,7 +169602,7 @@ webhooks: - owner - package_version - registry - repository: *750 + repository: *765 sender: *4 required: - action @@ -169011,12 +169782,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *747 + enterprise: *762 id: type: integer - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - id @@ -169093,7 +169864,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &782 + personal_access_token_request: &797 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -169243,10 +170014,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *747 - organization: *749 + enterprise: *762 + organization: *764 sender: *4 - installation: *748 + installation: *763 required: - action - personal_access_token_request @@ -169323,11 +170094,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *782 - enterprise: *747 - organization: *749 + personal_access_token_request: *797 + enterprise: *762 + organization: *764 sender: *4 - installation: *748 + installation: *763 required: - action - personal_access_token_request @@ -169403,11 +170174,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *782 - enterprise: *747 - organization: *749 + personal_access_token_request: *797 + enterprise: *762 + organization: *764 sender: *4 - installation: *748 + installation: *763 required: - action - personal_access_token_request @@ -169482,11 +170253,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *782 - organization: *749 - enterprise: *747 + personal_access_token_request: *797 + organization: *764 + enterprise: *762 sender: *4 - installation: *748 + installation: *763 required: - action - personal_access_token_request @@ -169591,7 +170362,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *783 + last_response: *798 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -169623,8 +170394,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 zen: description: Random string of GitHub zen. @@ -169869,10 +170640,10 @@ webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: &784 + enterprise: *762 + installation: *763 + organization: *764 + project_card: &799 title: Project Card type: object properties: @@ -169995,7 +170766,7 @@ webhooks: - creator - created_at - updated_at - repository: *750 + repository: *765 sender: *4 required: - action @@ -170076,11 +170847,11 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_card: *784 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project_card: *799 + repository: *765 sender: *4 required: - action @@ -170160,9 +170931,9 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 project_card: title: Project Card type: object @@ -170292,7 +171063,7 @@ webhooks: repository: anyOf: - type: 'null' - - *750 + - *765 sender: *4 required: - action @@ -170386,11 +171157,11 @@ webhooks: - from required: - note - enterprise: *747 - installation: *748 - organization: *749 - project_card: *784 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project_card: *799 + repository: *765 sender: *4 required: - action @@ -170484,9 +171255,9 @@ webhooks: - from required: - column_id - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 project_card: allOf: - title: Project Card @@ -170683,7 +171454,7 @@ webhooks: type: string required: - after_id - repository: *750 + repository: *765 sender: *4 required: - action @@ -170763,10 +171534,10 @@ webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - organization: *749 - project: &786 + enterprise: *762 + installation: *763 + organization: *764 + project: &801 title: Project type: object properties: @@ -170893,7 +171664,7 @@ webhooks: - creator - created_at - updated_at - repository: *750 + repository: *765 sender: *4 required: - action @@ -170973,10 +171744,10 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project_column: &785 + enterprise: *762 + installation: *763 + organization: *764 + project_column: &800 title: Project Column type: object properties: @@ -171016,7 +171787,7 @@ webhooks: - name - created_at - updated_at - repository: *750 + repository: *765 sender: *4 required: - action @@ -171095,14 +171866,14 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project_column: *785 + enterprise: *762 + installation: *763 + organization: *764 + project_column: *800 repository: anyOf: - type: 'null' - - *750 + - *765 sender: *4 required: - action @@ -171191,11 +171962,11 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project_column: *785 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project_column: *800 + repository: *765 sender: *4 required: - action @@ -171275,11 +172046,11 @@ webhooks: type: string enum: - moved - enterprise: *747 - installation: *748 - organization: *749 - project_column: *785 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project_column: *800 + repository: *765 sender: *4 required: - action @@ -171359,11 +172130,11 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - project: *786 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project: *801 + repository: *765 sender: *4 required: - action @@ -171443,14 +172214,14 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - project: *786 + enterprise: *762 + installation: *763 + organization: *764 + project: *801 repository: anyOf: - type: 'null' - - *750 + - *765 sender: *4 required: - action @@ -171551,11 +172322,11 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - project: *786 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project: *801 + repository: *765 sender: *4 required: - action @@ -171634,11 +172405,11 @@ webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - organization: *749 - project: *786 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + project: *801 + repository: *765 sender: *4 required: - action @@ -171719,8 +172490,8 @@ webhooks: type: string enum: - closed - installation: *748 - organization: *749 + installation: *763 + organization: *764 projects_v2: *278 sender: *4 required: @@ -171802,8 +172573,8 @@ webhooks: type: string enum: - created - installation: *748 - organization: *749 + installation: *763 + organization: *764 projects_v2: *278 sender: *4 required: @@ -171885,8 +172656,8 @@ webhooks: type: string enum: - deleted - installation: *748 - organization: *749 + installation: *763 + organization: *764 projects_v2: *278 sender: *4 required: @@ -172008,8 +172779,8 @@ webhooks: type: string to: type: string - installation: *748 - organization: *749 + installation: *763 + organization: *764 projects_v2: *278 sender: *4 required: @@ -172093,7 +172864,7 @@ webhooks: type: string enum: - archived - changes: &790 + changes: &805 type: object properties: archived_at: @@ -172109,9 +172880,9 @@ webhooks: - string - 'null' format: date-time - installation: *748 - organization: *749 - projects_v2_item: &787 + installation: *763 + organization: *764 + projects_v2_item: &802 title: Projects v2 Item description: An item belonging to a project type: object @@ -172251,9 +173022,9 @@ webhooks: - 'null' to: type: string - installation: *748 - organization: *749 - projects_v2_item: *787 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172335,9 +173106,9 @@ webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_item: *787 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172418,9 +173189,9 @@ webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_item: *787 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172525,7 +173296,7 @@ webhooks: oneOf: - type: string - type: integer - - &788 + - &803 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -172549,7 +173320,7 @@ webhooks: required: - id - name - - &789 + - &804 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -172589,8 +173360,8 @@ webhooks: oneOf: - type: string - type: integer - - *788 - - *789 + - *803 + - *804 type: - 'null' - string @@ -172613,9 +173384,9 @@ webhooks: - 'null' required: - body - installation: *748 - organization: *749 - projects_v2_item: *787 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172712,9 +173483,9 @@ webhooks: type: - string - 'null' - installation: *748 - organization: *749 - projects_v2_item: *787 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172797,10 +173568,10 @@ webhooks: type: string enum: - restored - changes: *790 - installation: *748 - organization: *749 - projects_v2_item: *787 + changes: *805 + installation: *763 + organization: *764 + projects_v2_item: *802 sender: *4 required: - action @@ -172882,8 +173653,8 @@ webhooks: type: string enum: - reopened - installation: *748 - organization: *749 + installation: *763 + organization: *764 projects_v2: *278 sender: *4 required: @@ -172965,9 +173736,9 @@ webhooks: type: string enum: - created - installation: *748 - organization: *749 - projects_v2_status_update: *791 + installation: *763 + organization: *764 + projects_v2_status_update: *806 sender: *4 required: - action @@ -173048,9 +173819,9 @@ webhooks: type: string enum: - deleted - installation: *748 - organization: *749 - projects_v2_status_update: *791 + installation: *763 + organization: *764 + projects_v2_status_update: *806 sender: *4 required: - action @@ -173196,9 +173967,9 @@ webhooks: - string - 'null' format: date - installation: *748 - organization: *749 - projects_v2_status_update: *791 + installation: *763 + organization: *764 + projects_v2_status_update: *806 sender: *4 required: - action @@ -173269,10 +174040,10 @@ webhooks: title: public event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - repository @@ -173349,13 +174120,13 @@ webhooks: type: string enum: - assigned - assignee: *767 - enterprise: *747 - installation: *748 - number: &792 + assignee: *782 + enterprise: *762 + installation: *763 + number: &807 description: The pull request number. type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -175726,7 +176497,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -175808,11 +176579,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -178176,7 +178947,7 @@ webhooks: - draft reason: type: string - repository: *750 + repository: *765 sender: *4 required: - action @@ -178258,11 +179029,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -180626,7 +181397,7 @@ webhooks: - draft reason: type: string - repository: *750 + repository: *765 sender: *4 required: - action @@ -180708,13 +181479,13 @@ webhooks: type: string enum: - closed - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: &793 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: &808 allOf: - - *596 + - *598 - type: object properties: allow_auto_merge: @@ -180776,7 +181547,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *750 + repository: *765 sender: *4 required: - action @@ -180857,12 +181628,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: *793 - repository: *750 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: *808 + repository: *765 sender: *4 required: - action @@ -180942,11 +181713,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *747 + enterprise: *762 milestone: *281 - number: *792 - organization: *749 - pull_request: &794 + number: *807 + organization: *764 + pull_request: &809 title: Pull Request type: object properties: @@ -183295,7 +184066,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -183374,11 +184145,11 @@ webhooks: type: string enum: - dequeued - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -185746,7 +186517,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *750 + repository: *765 sender: *4 required: - action @@ -185870,12 +186641,12 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: *793 - repository: *750 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: *808 + repository: *765 sender: *4 required: - action @@ -185955,11 +186726,11 @@ webhooks: type: string enum: - enqueued - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -188312,7 +189083,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -188392,11 +189163,11 @@ webhooks: type: string enum: - labeled - enterprise: *747 - installation: *748 - label: *766 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + label: *781 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -190766,7 +191537,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -190847,10 +191618,10 @@ webhooks: type: string enum: - locked - enterprise: *747 - installation: *748 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -193218,7 +193989,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -193298,12 +194069,12 @@ webhooks: type: string enum: - milestoned - enterprise: *747 + enterprise: *762 milestone: *281 - number: *792 - organization: *749 - pull_request: *794 - repository: *750 + number: *807 + organization: *764 + pull_request: *809 + repository: *765 sender: *4 required: - action @@ -193382,12 +194153,12 @@ webhooks: type: string enum: - opened - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: *793 - repository: *750 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: *808 + repository: *765 sender: *4 required: - action @@ -193468,12 +194239,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: *793 - repository: *750 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: *808 + repository: *765 sender: *4 required: - action @@ -193553,12 +194324,12 @@ webhooks: type: string enum: - reopened - enterprise: *747 - installation: *748 - number: *792 - organization: *749 - pull_request: *793 - repository: *750 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 + pull_request: *808 + repository: *765 sender: *4 required: - action @@ -193933,9 +194704,9 @@ webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: type: object properties: @@ -196187,7 +196958,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *765 sender: *4 required: - action @@ -196267,7 +197038,7 @@ webhooks: type: string enum: - deleted - comment: &796 + comment: &811 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -196560,9 +197331,9 @@ webhooks: - start_side - side - reactions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: type: object properties: @@ -198802,7 +199573,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *765 sender: *4 required: - action @@ -198882,11 +199653,11 @@ webhooks: type: string enum: - edited - changes: *795 - comment: *796 - enterprise: *747 - installation: *748 - organization: *749 + changes: *810 + comment: *811 + enterprise: *762 + installation: *763 + organization: *764 pull_request: type: object properties: @@ -201129,7 +201900,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *750 + repository: *765 sender: *4 required: - action @@ -201210,9 +201981,9 @@ webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: title: Simple Pull Request type: object @@ -203467,7 +204238,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *765 review: description: The review that was affected. type: object @@ -203718,9 +204489,9 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: title: Simple Pull Request type: object @@ -205834,8 +206605,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: &797 + repository: *765 + review: &812 description: The review that was affected. type: object properties: @@ -206073,12 +206844,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: description: The pull request number. type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -208447,7 +209218,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 requested_reviewer: title: User type: @@ -208533,12 +209304,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: description: The pull request number. type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -210914,7 +211685,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211109,12 +211880,12 @@ webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: description: The pull request number. type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -213485,7 +214256,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 requested_reviewer: title: User type: @@ -213572,12 +214343,12 @@ webhooks: type: string enum: - review_requested - enterprise: *747 - installation: *748 + enterprise: *762 + installation: *763 number: description: The pull request number. type: integer - organization: *749 + organization: *764 pull_request: title: Pull Request type: object @@ -215939,7 +216710,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 requested_team: title: Team description: Groups of organization members that gives permissions @@ -216123,9 +216894,9 @@ webhooks: type: string enum: - submitted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: title: Simple Pull Request type: object @@ -218383,8 +219154,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 - review: *797 + repository: *765 + review: *812 sender: *4 required: - action @@ -218464,9 +219235,9 @@ webhooks: type: string enum: - resolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: title: Simple Pull Request type: object @@ -220619,7 +221390,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *765 sender: *4 thread: type: object @@ -221016,9 +221787,9 @@ webhooks: type: string enum: - unresolved - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 pull_request: title: Simple Pull Request type: object @@ -223154,7 +223925,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *750 + repository: *765 sender: *4 thread: type: object @@ -223547,10 +224318,10 @@ webhooks: type: string enum: - stacked - enterprise: *747 - installation: *748 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -225920,7 +226691,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -226006,10 +226777,10 @@ webhooks: type: string before: type: string - enterprise: *747 - installation: *748 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -228366,7 +229137,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -228448,11 +229219,11 @@ webhooks: type: string enum: - unassigned - assignee: *798 - enterprise: *747 - installation: *748 - number: *792 - organization: *749 + assignee: *813 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -230824,7 +231595,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -230903,11 +231674,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *747 - installation: *748 - label: *766 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + label: *781 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -233268,7 +234039,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -233349,10 +234120,10 @@ webhooks: type: string enum: - unlocked - enterprise: *747 - installation: *748 - number: *792 - organization: *749 + enterprise: *762 + installation: *763 + number: *807 + organization: *764 pull_request: title: Pull Request type: object @@ -235703,7 +236474,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *750 + repository: *765 sender: *4 required: - action @@ -235906,7 +236677,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *747 + enterprise: *762 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -236001,8 +236772,8 @@ webhooks: - url - author - committer - installation: *748 - organization: *749 + installation: *763 + organization: *764 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -236601,9 +237372,9 @@ webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 registry_package: type: object properties: @@ -237080,7 +237851,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *781 + items: *796 summary: type: string tag_name: @@ -237136,7 +237907,7 @@ webhooks: - owner - package_version - registry - repository: *750 + repository: *765 sender: *4 required: - action @@ -237214,9 +237985,9 @@ webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 registry_package: type: object properties: @@ -237528,7 +238299,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *781 + items: *796 summary: type: string tag_name: @@ -237578,7 +238349,7 @@ webhooks: - owner - package_version - registry - repository: *750 + repository: *765 sender: *4 required: - action @@ -237655,10 +238426,10 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - release: &799 + enterprise: *762 + installation: *763 + organization: *764 + release: &814 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -237989,7 +238760,7 @@ webhooks: - updated_at - zipball_url - body - repository: *750 + repository: *765 sender: *4 required: - action @@ -238066,11 +238837,11 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - release: *799 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + release: *814 + repository: *765 sender: *4 required: - action @@ -238187,11 +238958,11 @@ webhooks: type: boolean required: - to - enterprise: *747 - installation: *748 - organization: *749 - release: *799 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + release: *814 + repository: *765 sender: *4 required: - action @@ -238269,9 +239040,9 @@ webhooks: type: string enum: - prereleased - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -238607,7 +239378,7 @@ webhooks: - string - 'null' format: uri - repository: *750 + repository: *765 sender: *4 required: - action @@ -238683,10 +239454,10 @@ webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - release: &800 + enterprise: *762 + installation: *763 + organization: *764 + release: &815 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -239019,7 +239790,7 @@ webhooks: - string - 'null' format: uri - repository: *750 + repository: *765 sender: *4 required: - action @@ -239095,11 +239866,11 @@ webhooks: type: string enum: - released - enterprise: *747 - installation: *748 - organization: *749 - release: *799 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + release: *814 + repository: *765 sender: *4 required: - action @@ -239175,11 +239946,11 @@ webhooks: type: string enum: - unpublished - enterprise: *747 - installation: *748 - organization: *749 - release: *800 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + release: *815 + repository: *765 sender: *4 required: - action @@ -239255,11 +240026,11 @@ webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *668 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + repository_advisory: *683 sender: *4 required: - action @@ -239335,11 +240106,11 @@ webhooks: type: string enum: - reported - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - repository_advisory: *668 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + repository_advisory: *683 sender: *4 required: - action @@ -239415,10 +240186,10 @@ webhooks: type: string enum: - archived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -239495,10 +240266,10 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -239576,10 +240347,10 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -239664,10 +240435,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -239782,10 +240553,10 @@ webhooks: - 'null' items: type: string - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -239857,10 +240628,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 status: type: string @@ -239941,10 +240712,10 @@ webhooks: type: string enum: - privatized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -240021,10 +240792,10 @@ webhooks: type: string enum: - publicized - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -240118,10 +240889,10 @@ webhooks: - name required: - repository - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -240201,10 +240972,10 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 repository_ruleset: *323 sender: *4 required: @@ -240283,10 +241054,10 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 repository_ruleset: *323 sender: *4 required: @@ -240365,10 +241136,10 @@ webhooks: type: string enum: - edited - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 repository_ruleset: *323 changes: type: object @@ -240430,16 +241201,16 @@ webhooks: properties: added: type: array - items: *617 + items: *619 deleted: type: array - items: *617 + items: *619 updated: type: array items: type: object properties: - rule: *617 + rule: *619 changes: type: object properties: @@ -240676,10 +241447,10 @@ webhooks: - from required: - owner - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -240757,10 +241528,10 @@ webhooks: type: string enum: - unarchived - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -240838,7 +241609,7 @@ webhooks: type: string enum: - create - alert: &801 + alert: &816 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -240963,10 +241734,10 @@ webhooks: enum: - auto_dismissed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241176,10 +241947,10 @@ webhooks: type: string enum: - dismissed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241257,11 +242028,11 @@ webhooks: type: string enum: - reopen - alert: *801 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *816 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241463,10 +242234,10 @@ webhooks: enum: - fixed - open - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241544,7 +242315,7 @@ webhooks: type: string enum: - assigned - alert: &803 + alert: &818 type: object properties: number: *180 @@ -241683,12 +242454,12 @@ webhooks: anyOf: - type: 'null' - *4 - metadata: *802 + metadata: *817 assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241766,11 +242537,11 @@ webhooks: type: string enum: - created - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -241851,11 +242622,11 @@ webhooks: type: string enum: - created - alert: *803 - installation: *748 - location: *804 - organization: *749 - repository: *750 + alert: *818 + installation: *763 + location: *819 + organization: *764 + repository: *765 sender: *4 required: - location @@ -242093,11 +242864,11 @@ webhooks: type: string enum: - metadata_created - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242174,11 +242945,11 @@ webhooks: type: string enum: - metadata_removed - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242255,11 +243026,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242337,11 +243108,11 @@ webhooks: type: string enum: - reopened - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242419,11 +243190,11 @@ webhooks: type: string enum: - resolved - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242501,12 +243272,12 @@ webhooks: type: string enum: - unassigned - alert: *803 + alert: *818 assignee: *4 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242584,11 +243355,11 @@ webhooks: type: string enum: - validated - alert: *803 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + alert: *818 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -242718,10 +243489,10 @@ webhooks: - organization - enterprise - - repository: *750 - enterprise: *747 - installation: *748 - organization: *749 + repository: *765 + enterprise: *762 + installation: *763 + organization: *764 sender: *4 required: - action @@ -242799,11 +243570,11 @@ webhooks: type: string enum: - published - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: &805 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + security_advisory: &820 description: The details of the security advisory, including summary, description, and severity. type: object @@ -242989,11 +243760,11 @@ webhooks: type: string enum: - updated - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 - security_advisory: *805 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 + security_advisory: *820 sender: *4 required: - action @@ -243066,10 +243837,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -243256,10 +244027,10 @@ webhooks: type: object properties: security_and_analysis: *296 - enterprise: *747 - installation: *748 - organization: *749 - repository: *340 + enterprise: *762 + installation: *763 + organization: *764 + repository: *342 sender: *4 required: - changes @@ -243337,12 +244108,12 @@ webhooks: type: string enum: - cancelled - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: &806 + sponsorship: &821 type: object properties: created_at: @@ -243647,12 +244418,12 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: *806 + sponsorship: *821 required: - action - sponsorship @@ -243740,12 +244511,12 @@ webhooks: type: string required: - from - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: *806 + sponsorship: *821 required: - action - changes @@ -243822,17 +244593,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &807 + effective_date: &822 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: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: *806 + sponsorship: *821 required: - action - sponsorship @@ -243906,7 +244677,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &808 + changes: &823 type: object properties: tier: @@ -243950,13 +244721,13 @@ webhooks: - from required: - tier - effective_date: *807 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + effective_date: *822 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: *806 + sponsorship: *821 required: - action - changes @@ -244033,13 +244804,13 @@ webhooks: type: string enum: - tier_changed - changes: *808 - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + changes: *823 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - sponsorship: *806 + sponsorship: *821 required: - action - changes @@ -244113,10 +244884,10 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -244200,10 +244971,10 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -244637,15 +245408,15 @@ webhooks: type: - string - 'null' - enterprise: *747 + enterprise: *762 id: description: The unique identifier of the status. type: integer - installation: *748 + installation: *763 name: type: string - organization: *749 - repository: *750 + organization: *764 + repository: *765 sender: *4 sha: description: The Commit SHA. @@ -244761,9 +245532,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -244852,9 +245623,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -244943,9 +245714,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -245034,9 +245805,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *748 - organization: *749 - repository: *750 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -245112,12 +245883,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 - team: &809 + team: &824 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -245347,9 +246118,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 repository: title: Repository description: A git repository @@ -245819,7 +246590,7 @@ webhooks: - topics - visibility sender: *4 - team: *809 + team: *824 required: - action - team @@ -245895,9 +246666,9 @@ webhooks: type: string enum: - created - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 repository: title: Repository description: A git repository @@ -246367,7 +247138,7 @@ webhooks: - topics - visibility sender: *4 - team: *809 + team: *824 required: - action - team @@ -246444,9 +247215,9 @@ webhooks: type: string enum: - deleted - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 repository: title: Repository description: A git repository @@ -246916,7 +247687,7 @@ webhooks: - topics - visibility sender: *4 - team: *809 + team: *824 required: - action - team @@ -247060,9 +247831,9 @@ webhooks: - from required: - permissions - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 repository: title: Repository description: A git repository @@ -247532,7 +248303,7 @@ webhooks: - topics - visibility sender: *4 - team: *809 + team: *824 required: - action - changes @@ -247610,9 +248381,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *747 - installation: *748 - organization: *749 + enterprise: *762 + installation: *763 + organization: *764 repository: title: Repository description: A git repository @@ -248082,7 +248853,7 @@ webhooks: - topics - visibility sender: *4 - team: *809 + team: *824 required: - action - team @@ -248158,10 +248929,10 @@ webhooks: type: string enum: - started - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 required: - action @@ -248234,17 +249005,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *747 + enterprise: *762 inputs: type: - object - 'null' additionalProperties: true - installation: *748 - organization: *749 + installation: *763 + organization: *764 ref: type: string - repository: *750 + repository: *765 sender: *4 workflow: type: string @@ -248326,10 +249097,10 @@ webhooks: type: string enum: - completed - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 workflow_job: allOf: @@ -248585,7 +249356,7 @@ webhooks: type: string required: - conclusion - deployment: *497 + deployment: *499 required: - action - repository @@ -248664,10 +249435,10 @@ webhooks: type: string enum: - in_progress - enterprise: *747 - installation: *748 - organization: *749 - repository: *750 + enterprise: *762 + installation: *763 + organization: *764 + repository: *765 sender: *4 workflow_job: allOf: @@ -248949,7 +249720,7 @@ webhooks: required: - status - steps - deployment: *497 + deployment: *499 require{"code":"deadline_exceeded","msg":"operation timed out"}