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 df8d852c9a..af082a9487 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 @@ -67321,7 +67321,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -121088,11 +121088,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -143395,6 +143399,12 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } } } }, @@ -323509,6 +323519,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } }, 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 a9ff155e1c..e153e0895d 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 @@ -49001,10 +49001,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -87963,11 +87963,19 @@ components: - all options: description: Options for single select fields. Only applicable when updating - single_select fields. + single_select fields. When provided, this array **replaces** the entire + existing set of options rather than adding to or updating individual options. + To retain or update an existing option, include it in the array with its + `id`. Options sent without an `id` are treated as new options and may + cause existing options to be deleted and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. Omit + this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -103990,6 +103998,10 @@ components: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" repository-advisory-create: type: object properties: @@ -241040,6 +241052,11 @@ components: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh 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 69c11cbbe0..1f62f172d3 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 @@ -67227,7 +67227,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -120514,11 +120514,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -142722,6 +142726,12 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } } } }, @@ -322663,6 +322673,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } }, 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 e45b211cdc..7235c9a748 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 @@ -48924,10 +48924,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -87539,11 +87539,19 @@ components: - all options: description: Options for single select fields. Only applicable when updating - single_select fields. + single_select fields. When provided, this array **replaces** the entire + existing set of options rather than adding to or updating individual options. + To retain or update an existing option, include it in the array with its + `id`. Options sent without an `id` are treated as new options and may + cause existing options to be deleted and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. Omit + this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -103500,6 +103508,10 @@ components: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" repository-advisory-create: type: object properties: @@ -240344,6 +240356,11 @@ components: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 3786e36467..aa8a24479c 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -67623,7 +67623,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -121835,11 +121835,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -144531,6 +144535,12 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } } } }, @@ -325417,6 +325427,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } }, diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index b9f5af77d4..cda1e79ab0 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -49186,10 +49186,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -88450,11 +88450,19 @@ components: - all options: description: Options for single select fields. Only applicable when updating - single_select fields. + single_select fields. When provided, this array **replaces** the entire + existing set of options rather than adding to or updating individual options. + To retain or update an existing option, include it in the array with its + `id`. Options sent without an `id` are treated as new options and may + cause existing options to be deleted and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. Omit + this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -104802,6 +104810,10 @@ components: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" repository-advisory-create: type: object properties: @@ -242275,6 +242287,11 @@ components: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh 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 9be276b2ad..fbe2fddc5e 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 @@ -160964,11 +160964,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -630435,7 +630439,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -630644,6 +630648,39 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running" + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending" + } + } + } } } }, @@ -630702,6 +630739,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } } 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 8cbd59cbc6..0038130f72 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 @@ -37990,11 +37990,20 @@ paths: - all options: description: Options for single select fields. Only applicable when - updating single_select fields. + updating single_select fields. When provided, this array **replaces** + the entire existing set of options rather than adding to or updating + individual options. To retain or update an existing option, include + it in the array with its `id`. Options sent without an `id` are + treated as new options and may cause existing options to be deleted + and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. + Omit this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -97666,10 +97675,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -97742,6 +97751,9 @@ paths: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: *633 examples: default: value: @@ -97780,6 +97792,11 @@ paths: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index fb54617687..6b522064ce 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -156233,11 +156233,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -617173,7 +617177,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -617382,6 +617386,39 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running" + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending" + } + } + } } } }, @@ -617440,6 +617477,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 5a491879dc..c08f0e9d97 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -37636,11 +37636,20 @@ paths: - all options: description: Options for single select fields. Only applicable when - updating single_select fields. + updating single_select fields. When provided, this array **replaces** + the entire existing set of options rather than adding to or updating + individual options. To retain or update an existing option, include + it in the array with its `id`. Options sent without an `id` are + treated as new options and may cause existing options to be deleted + and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. + Omit this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -97204,10 +97213,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -97280,6 +97289,9 @@ paths: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: *633 examples: default: value: @@ -97318,6 +97330,11 @@ paths: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index adc29bc009..f3aed58b08 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -163480,11 +163480,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -644459,7 +644463,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -644668,6 +644672,39 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running" + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending" + } + } + } } } }, @@ -644726,6 +644763,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 875ea95491..6f5c800113 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -38308,11 +38308,20 @@ paths: - all options: description: Options for single select fields. Only applicable when - updating single_select fields. + updating single_select fields. When provided, this array **replaces** + the entire existing set of options rather than adding to or updating + individual options. To retain or update an existing option, include + it in the array with its `id`. Options sent without an `id` are + treated as new options and may cause existing options to be deleted + and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. + Omit this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -98427,10 +98436,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security). 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: @@ -98503,6 +98512,9 @@ paths: type: string description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + generic_secrets_backfill_scans: + type: array + items: *633 examples: default: value: @@ -98541,6 +98553,11 @@ paths: completed_at: '2024-10-07T02:55:00Z' pattern_slug: my-custom-pattern pattern_scope: organization + generic_secrets_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 9287c61130..6da3b03a60 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -218076,11 +218076,15 @@ ] }, "options": { - "description": "Options for single select fields. Only applicable when updating single_select fields.", + "description": "Options for single select fields. Only applicable when updating single_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.", "type": "array", "items": { "type": "object", "properties": { + "id": { + "description": "The id of an existing option to retain or update. Omit this when creating a new option.", + "type": "integer" + }, "name": { "description": "Name of the option.", "type": "string" @@ -696699,7 +696703,7 @@ "/repos/{owner}/{repo}/secret-scanning/scan-history": { "get": { "summary": "Get secret scanning scan history for a repository", - "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\"\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.", + "description": "Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security).\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" ], @@ -696908,6 +696912,39 @@ } ] } + }, + "generic_secrets_backfill_scans": { + "type": "array", + "items": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running" + }, + "started_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending" + } + } + } } } }, @@ -696966,6 +697003,14 @@ "pattern_slug": "my-custom-pattern", "pattern_scope": "organization" } + ], + "generic_secrets_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z" + } ] } } diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index a28e6404db..9ae0b470a4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -52702,11 +52702,20 @@ paths: - all options: description: Options for single select fields. Only applicable when - updating single_select fields. + updating single_select fields. When provided, this array **replaces** + the entire existing set of options rather than adding to or updating + individual options. To retain or update an existing option, include + it in the array with its `id`. Options sent without an `id` are + treated as new options and may cause existing options to be deleted + and recreated. type: array items: type: object properties: + id: + description: The id of an existing option to retain or update. + Omit this when creating a new option. + type: integer name: description: Name of the option. type: string @@ -111754,10 +111763,10 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + Lists the latest default incremental and backfill scans by type for a repository. > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security)." + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/enterprise-cloud@latest//get-started/learning-about-github/about-github-advanced-security). OAuth app tokens and personal access tokens (classic) need the `repo`{"code":"deadline_exceeded","msg":"operation timed out"}