diff --git a/CHANGELOG.md b/CHANGELOG.md index dbeddafa8930..467b1b3c39e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Docs changelog +**9 April 2026** + +We have added documentation for the code security risk assessment (CSRA), a free self-serve tool that helps organization admins and security managers understand their organization's exposure to code vulnerabilities. +New content includes: + +* [Code security risk assessment](https://docs.github.com/en/code-security/concepts/code-scanning/code-security-risk-assessment): What the CSRA is, who can run it, what it scans, and how it relates to the secret risk assessment. +* [Running a code security risk assessment](https://docs.github.com/en/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-vulnerability-risk): How to generate and rerun a CSRA report. +* [Interpreting code security risk assessment results](https://docs.github.com/en/code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results): How to read the results dashboard, understand vulnerability and rule breakdowns, and enable Code Security directly from the assessment. + +
Agent ID (optional, defaults to coding agent)
" - }, { "type": "string", - "name": "problem_statement", - "description": "Additional prompting for the agent
" - }, - { - "type": "string", - "name": "event_content", - "description": "User's written prompt
", + "name": "prompt", + "description": "The user's prompt for the agent
", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Custom agent identifier
" - }, { "type": "boolean", "name": "create_pull_request", - "description": "Whether to create a PR
" + "description": "Whether to create a PR.
", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "Base ref for new branch/PR
" } ], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository
", + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository.
", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/fpt-2022-11-28/gists.json b/src/rest/data/fpt-2022-11-28/gists.json index 5753b16e2b56..ced57c43e2b7 100644 --- a/src/rest/data/fpt-2022-11-28/gists.json +++ b/src/rest/data/fpt-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
Agent ID (optional, defaults to coding agent)
" - }, { "type": "string", - "name": "problem_statement", - "description": "Additional prompting for the agent
" - }, - { - "type": "string", - "name": "event_content", - "description": "User's written prompt
", + "name": "prompt", + "description": "The user's prompt for the agent
", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Custom agent identifier
" - }, { "type": "boolean", "name": "create_pull_request", - "description": "Whether to create a PR
" + "description": "Whether to create a PR.
", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "Base ref for new branch/PR
" } ], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository
", + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository.
", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/fpt-2026-03-10/gists.json b/src/rest/data/fpt-2026-03-10/gists.json index 2bd2d7c11c7a..4c15b84c53bc 100644 --- a/src/rest/data/fpt-2026-03-10/gists.json +++ b/src/rest/data/fpt-2026-03-10/gists.json @@ -1827,7 +1827,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
Agent ID (optional, defaults to coding agent)
" - }, { "type": "string", - "name": "problem_statement", - "description": "Additional prompting for the agent
" - }, - { - "type": "string", - "name": "event_content", - "description": "User's written prompt
", + "name": "prompt", + "description": "The user's prompt for the agent
", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Custom agent identifier
" - }, { "type": "boolean", "name": "create_pull_request", - "description": "Whether to create a PR
" + "description": "Whether to create a PR.
", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "Base ref for new branch/PR
" } ], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository
", + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository.
", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/ghec-2022-11-28/gists.json b/src/rest/data/ghec-2022-11-28/gists.json index bc4027e59470..3c8ae0626b74 100644 --- a/src/rest/data/ghec-2022-11-28/gists.json +++ b/src/rest/data/ghec-2022-11-28/gists.json @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "organization_name", + "description": "The name of the organization to filter on.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).
The status of the dismissal request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists requests to dismiss secret scanning alerts in an enterprise.
\nThe authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
A list of the alert dismissal requests.
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri" + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of the alert dismissal requests.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -12504,4 +13041,4 @@ } } ] -} +} \ No newline at end of file diff --git a/src/rest/data/ghec-2026-03-10/agent-tasks.json b/src/rest/data/ghec-2026-03-10/agent-tasks.json index 40550f3a7299..1dab325724e0 100644 --- a/src/rest/data/ghec-2026-03-10/agent-tasks.json +++ b/src/rest/data/ghec-2026-03-10/agent-tasks.json @@ -146,10 +146,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -293,26 +292,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -322,6 +320,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -433,20 +435,10 @@ } ], "bodyParameters": [ - { - "type": "integer", - "name": "agent_id", - "description": "Agent ID (optional, defaults to coding agent)
" - }, { "type": "string", - "name": "problem_statement", - "description": "Additional prompting for the agent
" - }, - { - "type": "string", - "name": "event_content", - "description": "User's written prompt
", + "name": "prompt", + "description": "The user's prompt for the agent
", "isRequired": true }, { @@ -454,15 +446,11 @@ "name": "model", "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Custom agent identifier
" - }, { "type": "boolean", "name": "create_pull_request", - "description": "Whether to create a PR
" + "description": "Whether to create a PR.
", + "default": false }, { "type": "string", @@ -470,7 +458,7 @@ "description": "Base ref for new branch/PR
" } ], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository
", + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a new task for a repository.
", "codeExamples": [ { "request": { @@ -478,8 +466,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "event_content": "Fix the login button on the homepage", - "create_pull_request": true, + "prompt": "Fix the login button on the homepage", "base_ref": "main" }, "parameters": { @@ -639,26 +626,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -668,6 +654,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -806,10 +796,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -834,9 +823,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -968,26 +958,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -997,6 +986,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1090,15 +1083,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1132,47 +1116,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -1181,20 +1128,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", @@ -1358,10 +1295,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1505,26 +1441,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1534,6 +1469,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1666,10 +1605,9 @@ "artifacts": [ { "provider": "github", - "type": "github_resource", + "type": "pull", "data": { - "id": 42, - "type": "pull_request" + "id": 42 } } ], @@ -1694,9 +1632,10 @@ "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T01:00:00Z", "completed_at": "2025-01-01T01:00:00Z", - "event_content": "Fix the login button on the homepage", + "prompt": "Fix the login button on the homepage", "head_ref": "copilot/fix-1", - "base_ref": "main" + "base_ref": "main", + "model": "claude-sonnet-4.6" } ] }, @@ -1828,26 +1767,25 @@ "type": { "type": "string", "enum": [ - "github_resource", + "pull", "branch" ], - "description": "Discriminator for data shape" + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" }, "data": { "oneOf": [ { "type": "object", "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], "properties": { "id": { "type": "integer", "format": "int64", "description": "GitHub resource ID" }, - "type": { - "type": "string", - "description": "Resource type (e.g., pull_request, issue)" - }, "global_id": { "type": "string", "description": "GraphQL global ID" @@ -1857,6 +1795,10 @@ { "type": "object", "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], "properties": { "head_ref": { "type": "string", @@ -1950,15 +1892,6 @@ } } }, - "agent_id": { - "type": "integer", - "format": "int64", - "description": "Agent ID" - }, - "agent_task_id": { - "type": "string", - "description": "Agent internal task ID" - }, "task_id": { "type": "string", "description": "Task ID this session belongs to" @@ -1992,47 +1925,10 @@ "format": "date-time", "description": "Completion timestamp" }, - "event_type": { - "type": "string", - "description": "Type of event that triggered this session" - }, - "event_url": { - "type": "string", - "description": "URL of the triggering event" - }, - "event_content": { + "prompt": { "type": "string", "description": "Content of the triggering event" }, - "event_identifiers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Identifiers for tracking" - }, - "resource_type": { - "type": "string", - "description": "Type of resource associated with this session" - }, - "resource_id": { - "type": "integer", - "format": "int64", - "description": "Resource ID" - }, - "resource_number": { - "type": "integer", - "format": "int32", - "description": "Resource number (e.g., PR number)" - }, - "resource_global_id": { - "type": "string", - "description": "GraphQL global ID of the resource" - }, - "resource_state": { - "type": "string", - "description": "State of the associated resource" - }, "head_ref": { "type": "string", "description": "Head branch name" @@ -2041,20 +1937,10 @@ "type": "string", "description": "Base branch name" }, - "workflow_run_id": { - "type": "integer", - "format": "int64", - "description": "GitHub Actions workflow run ID" - }, "model": { "type": "string", "description": "Model used for this session" }, - "premium_requests": { - "type": "number", - "format": "double", - "description": "Premium request count" - }, "error": { "type": "object", "description": "Error details for a failed session", diff --git a/src/rest/data/ghec-2026-03-10/gists.json b/src/rest/data/ghec-2026-03-10/gists.json index 50dad4adda46..a977f44907cd 100644 --- a/src/rest/data/ghec-2026-03-10/gists.json +++ b/src/rest/data/ghec-2026-03-10/gists.json @@ -1827,7 +1827,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the providers parameter.
A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., github_secret_scanning, clojars).\nYou can find the provider slug in the provider_slug field of each alert.\nCannot be combined with the exclude_providers parameter.
The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "organization_name", + "description": "The name of the organization to filter on.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for rule suites that occurred in the past 7 days (168 hours).
The status of the dismissal request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists requests to dismiss secret scanning alerts in an enterprise.
\nThe authenticated user must be an enterprise owner or an enterprise security manager to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
A list of the alert dismissal requests.
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 17, + "reason": "false_positive" + } + ], + "resource_identifier": 17, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/21", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/17" + }, + { + "id": 22, + "number": 43, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning_closure", + "data": [ + { + "secret_type": "adafruit_io_key", + "alert_number": 19 + } + ], + "resource_identifier": 19, + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 46, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "approved", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/secret-scanning/22", + "html_url": "https://github.com/octo-org/smile/security/secret-scanning/19" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning alert dismissal request", + "description": "A dismissal request made by a user asking to close a secret scanning alert in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the dismissal request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the dismissal request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the dismissal request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the dismissal request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the dismissal request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the dismissal." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the dismissal." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the secret alert that is being requested to be dismissed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "alert_number": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "reason": { + "type": "string", + "description": "The reason the user provided for requesting the dismissal.", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The number of the secret scanning alert that was detected." + }, + "status": { + "type": "string", + "description": "The status of the dismissal request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "expired" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the dismissal request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the dismissal request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the dismissal request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "description": "The URL to view the dismissal request in a browser.", + "format": "uri" + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of the alert dismissal requests.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -12504,4 +13041,4 @@ } } ] -} +} \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/gists.json b/src/rest/data/ghes-3.14-2022-11-28/gists.json index 34c581ede6ea..ec0b6d5676b4 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/gists.json +++ b/src/rest/data/ghes-3.14-2022-11-28/gists.json @@ -2599,7 +2599,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.
\nAt least one of description or files is required.
This endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a specified gist revision.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Lists the comments on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Creates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Gets a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.Updates a comment on a gist.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -261235,6 +261245,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -262091,6 +262111,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -262947,6 +262977,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -263803,6 +263843,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -264659,6 +264709,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -265650,6 +265710,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -266507,6 +266577,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 23bc0fe6ca12..8479c5bd7d97 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -269144,6 +269144,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -270135,6 +270145,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -270991,6 +271011,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -271847,6 +271877,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -272703,6 +272743,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -273559,6 +273609,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -274550,6 +274610,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", @@ -275407,6 +275477,16 @@ "name": "secret_type_display_name", "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The provider of the secret that was detected.
" + }, + { + "type": "string or null", + "name": "provider_slug", + "description": "The slug identifier for the provider of the secret that was detected.
" + }, { "type": "string", "name": "validity", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 6236e7eb6cda..ad671ef70bdd 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2d6cbdb1321b97517f0af20e94eff59e89a36c25" + "sha": "36e6d2087a74bda6b56e450420eee3427798bc75" } \ No newline at end of file