diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index ba71abed70..bf171d60bd 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -99525,1100 +99525,890 @@ "used_in_tests" ] }, - "organization-secret-scanning-alert": { + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "url": { - "$ref": "#/components/schemas/alert-url" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, - "locations_url": { + "blob_sha": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "resolved_at": { + "blob_url": { "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "description": "The API URL to get the associated blob resource" }, - "secret_type": { + "commit_sha": { "type": "string", - "description": "The type of secret that secret scanning detected." + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "secret_type_display_name": { + "commit_url": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true + "description": "The file path of the wiki page", + "example": "/example/Home.md" }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_comment": { + "blob_sha": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "push_protection_bypass_request_html_url": { + "page_url": { "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "resolution_comment": { + "commit_sha": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "validity": { + "commit_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" } - } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] }, - "actor": { - "title": "Actor", - "description": "Actor", + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { + "issue_title_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" } }, "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" + "issue_title_url" ] }, - "nullable-milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", "type": "object", "properties": { - "url": { + "issue_body_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" }, - "open_issues": { - "type": "integer", - "example": 4 + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" }, - "closed_issues": { - "type": "integer", - "example": 8 + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" ], "nullable": true }, - "issue-type": { - "title": "Issue Type", - "description": "The type of issue.", + "organization-secret-scanning-alert": { "type": "object", - "nullable": true, "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." + "number": { + "$ref": "#/components/schemas/alert-number" }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." + "created_at": { + "$ref": "#/components/schemas/alert-created-at" }, - "name": { - "type": "string", - "description": "The name of the issue type." + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" }, - "description": { + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", - "description": "The description of the issue type.", - "nullable": true + "format": "uri", + "description": "The REST API URL of the code locations for this alert." }, - "color": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "updated_at": { + "secret_type": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" + "description": "The type of secret that secret scanning detected." }, - "node_id": { + "secret_type_display_name": { "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "client_id": { + "secret": { "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" + "description": "The secret that was detected." }, - "owner": { - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } - ] + "repository": { + "$ref": "#/components/schemas/simple-repository" }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true }, - "description": { + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "example": "The description of the app.", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "external_url": { + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "example": "https://example.com" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "html_url": { + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "example": "https://github.com/apps/super-ci" + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "created_at": { + "resolution_comment": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "description": "The comment that was optionally added when this alert was closed", + "nullable": true }, - "updated_at": { + "validity": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author-association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + } }, - "reaction-rollup": { - "title": "Reaction Rollup", + "actor": { + "title": "Actor", + "description": "Actor", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { + "id": { "type": "integer" }, - "confused": { - "type": "integer" + "login": { + "type": "string" }, - "heart": { - "type": "integer" + "display_login": { + "type": "string" }, - "hooray": { - "type": "integer" + "gravatar_id": { + "type": "string", + "nullable": true }, - "eyes": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "rocket": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ + "id", + "login", + "gravatar_id", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "avatar_url" ] }, - "sub-issues-summary": { - "title": "Sub-issues Summary", + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { - "type": "string" - }, - "comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, - "events_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "example": 1002604 }, - "html_url": { + "node_id": { "type": "string", - "format": "uri" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { + "creator": { "$ref": "#/components/schemas/nullable-simple-user" }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" + "open_issues": { + "type": "integer", + "example": 4 }, - "locked": { - "type": "boolean" + "closed_issues": { + "type": "integer", + "example": 8 }, - "active_lock_reason": { + "created_at": { "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", + "example": "2013-02-12T13:22:01Z", "nullable": true }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { + "due_on": { "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/issue-type" - }, - "repository": { - "$ref": "#/components/schemas/repository" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - }, - "sub_issues_summary": { - "$ref": "#/components/schemas/sub-issues-summary" + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ - "assignee", + "closed_issues", + "creator", + "description", + "due_on", "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", "labels_url", - "milestone", + "html_url", "number", - "repository_url", + "open_issues", "state", - "locked", "title", "url", - "user", - "author_association", "created_at", "updated_at" - ] + ], + "nullable": true }, - "issue-comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", - "format": "int64" + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" + "description": "The node identifier of the issue type." }, - "body_html": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the issue type." }, - "html_url": { + "description": { "type": "string", - "format": "uri" + "description": "The description of the issue type.", + "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "description": "The time the issue type created.", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" + "name", + "description" ] }, - "event": { - "title": "Event", - "description": "Event", + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "type": { + "node_id": { "type": "string", - "nullable": true + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "actor": { - "$ref": "#/components/schemas/actor" + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/enterprise" } - }, - "required": [ - "id", - "name", - "url" ] }, - "org": { - "$ref": "#/components/schemas/actor" + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" }, - "payload": { + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "action": { + "issues": { "type": "string" }, - "issue": { - "$ref": "#/components/schemas/issue" + "checks": { + "type": "string" }, - "comment": { - "$ref": "#/components/schemas/issue-comment" + "metadata": { + "type": "string" }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "public": { - "type": "boolean" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "link-with-type": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" + "author-association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "feed": { - "title": "Feed", - "description": "Feed", + "reaction-rollup": { + "title": "Reaction Rollup", "type": "object", "properties": { - "timeline_url": { + "url": { "type": "string", - "example": "https://github.com/timeline" + "format": "uri" }, - "user_url": { - "type": "string", - "example": "https://github.com/{user}" + "total_count": { + "type": "integer" }, - "current_user_public_url": { - "type": "string", - "example": "https://github.com/octocat" + "+1": { + "type": "integer" }, - "current_user_url": { - "type": "string", - "example": "https://github.com/octocat.private?token=abc123" + "-1": { + "type": "integer" }, - "current_user_actor_url": { - "type": "string", - "example": "https://github.com/octocat.private.actor?token=abc123" + "laugh": { + "type": "integer" }, - "current_user_organization_url": { - "type": "string", - "example": "https://github.com/octocat-org" + "confused": { + "type": "integer" }, - "current_user_organization_urls": { - "type": "array", - "example": [ - "https://github.com/organizations/github/octocat.private.atom?token=abc123" - ], - "items": { - "type": "string", - "format": "uri" - } + "heart": { + "type": "integer" }, - "security_advisories_url": { - "type": "string", - "example": "https://github.com/security-advisories" + "hooray": { + "type": "integer" }, - "repository_discussions_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions", - "description": "A feed of discussions for a given repository." + "eyes": { + "type": "integer" }, - "repository_discussions_category_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", - "description": "A feed of discussions for a given repository and category." + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "_links": { - "type": "object", - "properties": { - "timeline": { - "$ref": "#/components/schemas/link-with-type" - }, - "user": { - "$ref": "#/components/schemas/link-with-type" - }, - "security_advisories": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_public": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_actor": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organization": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organizations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "repository_discussions": { - "$ref": "#/components/schemas/link-with-type" - }, - "repository_discussions_category": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "required": [ - "timeline", - "user" - ] + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" } }, "required": [ - "_links", - "timeline_url", - "user_url" + "total", + "completed", + "percent_completed" ] }, - "base-gist": { - "title": "Base Gist", - "description": "Base Gist", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "format": "int64" }, - "forks_url": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "commits_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "type": "string" - }, - "node_id": { + "labels_url": { "type": "string" }, - "git_pull_url": { + "comments_url": { "type": "string", "format": "uri" }, - "git_push_url": { + "events_url": { "type": "string", "format": "uri" }, @@ -100626,510 +100416,524 @@ "type": "string", "format": "uri" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" }, - "public": { - "type": "boolean" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" }, - "created_at": { + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", "type": "string", - "format": "date-time" + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned" + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" }, - "description": { + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "truncated": { - "type": "boolean" + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "forks": { + "assignees": { "type": "array", - "items": {} + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true }, - "history": { - "type": "array", - "items": {} + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", "user", - "files", + "author_association", "created_at", "updated_at" ] }, - "public-user": { - "title": "Public User", - "description": "Public User", + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, - "user_view_type": { - "type": "string" - }, "node_id": { "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "gists_url": { + "body_text": { "type": "string" }, - "starred_url": { + "body_html": { "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "events_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": "string", - "nullable": true + "author_association": { + "$ref": "#/components/schemas/author-association" }, - "company": { - "type": "string", - "nullable": true + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" }, - "blog": { - "type": "string", - "nullable": true - }, - "location": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "notification_email": { - "type": "string", - "format": "email", - "nullable": true - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" }, - "twitter_username": { + "type": { "type": "string", "nullable": true }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "actor": { + "$ref": "#/components/schemas/actor" }, - "plan": { + "repo": { "type": "object", "properties": { - "collaborators": { + "id": { "type": "integer" }, "name": { "type": "string" }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "collaborators", + "id", "name", - "space", - "private_repos" + "url" ] }, - "private_gists": { - "type": "integer", - "example": 1 - }, - "total_private_repos": { - "type": "integer", - "example": 2 + "org": { + "$ref": "#/components/schemas/actor" }, - "owned_private_repos": { - "type": "integer", - "example": 2 + "payload": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "comment": { + "$ref": "#/components/schemas/issue-comment" + }, + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + } }, - "disk_usage": { - "type": "integer", - "example": 1 + "public": { + "type": "boolean" }, - "collaborators": { - "type": "integer", - "example": 3 + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "actor", + "repo", + "payload", + "public", + "created_at" + ] }, - "gist-history": { - "title": "Gist History", - "description": "Gist History", + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", "type": "object", "properties": { - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "href": { + "type": "string" }, - "version": { + "type": { "type": "string" + } + }, + "required": [ + "href", + "type" + ] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" }, - "committed_at": { + "user_url": { "type": "string", - "format": "date-time" + "example": "https://github.com/{user}" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" }, - "url": { + "current_user_url": { "type": "string", - "format": "uri" - } - } - }, - "gist-simple": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "$ref": "#/components/schemas/public-user" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } + "example": "https://github.com/octocat.private?token=abc123" }, - "history": { - "deprecated": true, - "nullable": true, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], "items": { - "$ref": "#/components/schemas/gist-history" + "type": "string", + "format": "uri" } }, - "fork_of": { - "nullable": true, - "title": "Gist", - "description": "Gist", + "security_advisories_url": { + "type": "string", + "example": "https://github.com/security-advisories" + }, + "repository_discussions_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions", + "description": "A feed of discussions for a given repository." + }, + "repository_discussions_category_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", + "description": "A feed of discussions for a given repository and category." + }, + "_links": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" + "timeline": { + "$ref": "#/components/schemas/link-with-type" }, - "commits_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/link-with-type" }, - "id": { - "type": "string" + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" }, - "node_id": { - "type": "string" + "current_user": { + "$ref": "#/components/schemas/link-with-type" }, - "git_pull_url": { - "type": "string", - "format": "uri" + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" }, - "git_push_url": { - "type": "string", - "format": "uri" + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" }, - "html_url": { - "type": "string", - "format": "uri" + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } + "current_user_organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/link-with-type" } }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "repository_discussions": { + "$ref": "#/components/schemas/link-with-type" }, - "history": { - "type": "array", - "items": {} + "repository_discussions_category": { + "$ref": "#/components/schemas/link-with-type" } }, "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" + "timeline", + "user" ] - }, + } + }, + "required": [ + "_links", + "timeline_url", + "user_url" + ] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri" }, "forks_url": { - "type": "string" + "type": "string", + "format": "uri" }, "commits_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "string" @@ -101138,18 +100942,20 @@ "type": "string" }, "git_pull_url": { - "type": "string" + "type": "string", + "format": "uri" }, "git_push_url": { - "type": "string" + "type": "string", + "format": "uri" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "files": { "type": "object", "additionalProperties": { - "nullable": true, "type": "object", "properties": { "filename": { @@ -101167,12 +100973,6 @@ "size": { "type": "integer" }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", @@ -101185,10 +100985,12 @@ "type": "boolean" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "description": { "type": "string", @@ -101201,460 +101003,985 @@ "type": "boolean" }, "user": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/nullable-simple-user" }, "comments_url": { - "type": "string" + "type": "string", + "format": "uri" }, "owner": { "$ref": "#/components/schemas/simple-user" }, "truncated": { "type": "boolean" - } - } - }, - "gist-comment": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDExOkdpc3RDb21tZW50MQ==" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + "forks": { + "type": "array", + "items": {} }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535, - "example": "Body of the attachment" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" + "history": { + "type": "array", + "items": {} } }, "required": [ - "url", "id", "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", "user", - "body", - "author_association", + "files", "created_at", "updated_at" ] }, - "gist-commit": { - "title": "Gist Commit", - "description": "Gist Commit", + "public-user": { + "title": "Public User", + "description": "Public User", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + "login": { + "type": "string" }, - "version": { - "type": "string", - "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + "id": { + "type": "integer", + "format": "int64" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "user_view_type": { + "type": "string" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "node_id": { + "type": "string" }, - "committed_at": { - "type": "string", - "format": "date-time", - "example": "2010-04-14T02:15:15Z" - } - }, - "required": [ - "url", - "user", - "version", - "committed_at", - "change_status" - ] - }, - "gitignore-template": { - "title": "Gitignore Template", - "description": "Gitignore Template", - "type": "object", - "properties": { - "name": { + "avatar_url": { "type": "string", - "example": "C" + "format": "uri" }, - "source": { + "gravatar_id": { "type": "string", - "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" - } - }, - "required": [ - "name", - "source" - ] - }, - "license-simple": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { + "nullable": true + }, + "url": { "type": "string", - "example": "mit" + "format": "uri" }, - "name": { + "html_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { + "followers_url": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "format": "uri" }, - "spdx_id": { + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { "type": "string", - "nullable": true, - "example": "MIT" + "format": "uri" }, - "node_id": { + "organizations_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - }, - "license": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { + }, + "events_url": { + "type": "string" + }, + "received_events_url": { "type": "string", - "example": "mit" + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" }, "name": { "type": "string", - "example": "MIT License" + "nullable": true }, - "spdx_id": { + "company": { "type": "string", - "example": "MIT", "nullable": true }, - "url": { + "blog": { "type": "string", - "format": "uri", - "example": "https://api.github.com/licenses/mit", "nullable": true }, - "node_id": { + "location": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "nullable": true }, - "html_url": { + "email": { "type": "string", - "format": "uri", - "example": "http://choosealicense.com/licenses/mit/" + "format": "email", + "nullable": true }, - "description": { + "notification_email": { "type": "string", - "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + "format": "email", + "nullable": true }, - "implementation": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { "type": "string", - "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + "nullable": true }, - "permissions": { - "type": "array", - "example": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ], - "items": { - "type": "string" - } + "twitter_username": { + "type": "string", + "nullable": true }, - "conditions": { - "type": "array", - "example": [ - "include-copyright" - ], - "items": { - "type": "string" - } + "public_repos": { + "type": "integer" }, - "limitations": { - "type": "array", - "example": [ - "no-liability" - ], - "items": { - "type": "string" - } + "public_gists": { + "type": "integer" }, - "body": { + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { "type": "string", - "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + "format": "date-time" }, - "featured": { - "type": "boolean", - "example": true - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] - }, - "marketplace-listing-plan": { - "title": "Marketplace Listing Plan", - "description": "Marketplace Listing Plan", - "type": "object", - "properties": { - "url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313" + "format": "date-time" }, - "accounts_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] }, - "id": { + "private_gists": { "type": "integer", - "example": 1313 + "example": 1 }, - "number": { + "total_private_repos": { "type": "integer", - "example": 3 - }, - "name": { - "type": "string", - "example": "Pro" - }, - "description": { - "type": "string", - "example": "A professional-grade CI solution" + "example": 2 }, - "monthly_price_in_cents": { + "owned_private_repos": { "type": "integer", - "example": 1099 + "example": 2 }, - "yearly_price_in_cents": { + "disk_usage": { "type": "integer", - "example": 11870 - }, - "price_model": { - "type": "string", - "enum": [ - "FREE", - "FLAT_RATE", - "PER_UNIT" - ], - "example": "FLAT_RATE" - }, - "has_free_trial": { - "type": "boolean", - "example": true - }, - "unit_name": { - "type": "string", - "nullable": true - }, - "state": { - "type": "string", - "example": "published" + "example": 1 }, - "bullets": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "Up to 25 private repositories", - "11 concurrent builds" - ] + "collaborators": { + "type": "integer", + "example": 3 } }, "required": [ - "url", - "accounts_url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", "name", - "description", - "has_free_trial", - "price_model", - "unit_name", - "monthly_price_in_cents", - "state", - "yearly_price_in_cents", - "bullets" - ] + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false }, - "marketplace-purchase": { - "title": "Marketplace Purchase", - "description": "Marketplace Purchase", + "gist-history": { + "title": "Gist History", + "description": "Gist History", "type": "object", "properties": { - "url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "organization_billing_email": { + "version": { "type": "string" }, - "email": { + "committed_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "marketplace_pending_change": { + "change_status": { "type": "object", "properties": { - "is_installed": { - "type": "boolean" - }, - "effective_date": { - "type": "string" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "id": { + "total": { "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" - } - }, - "nullable": true - }, - "marketplace_purchase": { - "type": "object", - "properties": { - "billing_cycle": { - "type": "string" - }, - "next_billing_date": { - "type": "string", - "nullable": true - }, - "is_installed": { - "type": "boolean" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "on_free_trial": { - "type": "boolean" - }, - "free_trial_ends_on": { - "type": "string", - "nullable": true - }, - "updated_at": { - "type": "string" + "additions": { + "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" + "deletions": { + "type": "integer" } } + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "url", - "id", - "type", - "login", - "marketplace_purchase" - ] + } }, - "api-overview": { - "title": "Api Overview", - "description": "Api Overview", + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", "type": "object", "properties": { - "verifiable_password_authentication": { - "type": "boolean", - "example": true - }, - "ssh_key_fingerprints": { - "type": "object", - "properties": { + "forks": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/public-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "history": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-history" + } + }, + "fork_of": { + "nullable": true, + "title": "Gist", + "description": "Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + } + } + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": [ + "url", + "user", + "version", + "committed_at", + "change_status" + ] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "C" + }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": [ + "name", + "source" + ] + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "spdx_id": { + "type": "string", + "example": "MIT", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "example": [ + "include-copyright" + ], + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "example": [ + "no-liability" + ], + "items": { + "type": "string" + } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { + "type": "boolean", + "example": true + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { + "type": "integer", + "example": 1313 + }, + "number": { + "type": "integer", + "example": 3 + }, + "name": { + "type": "string", + "example": "Pro" + }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { + "type": "integer", + "example": 1099 + }, + "yearly_price_in_cents": { + "type": "integer", + "example": 11870 + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ], + "example": "FLAT_RATE" + }, + "has_free_trial": { + "type": "boolean", + "example": true + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "example": "published" + }, + "bullets": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "organization_billing_email": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true + }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { + "type": "boolean" + }, + "effective_date": { + "type": "string" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "id": { + "type": "integer" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { + "type": "string" + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "is_installed": { + "type": "boolean" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": [ + "url", + "id", + "type", + "login", + "marketplace_purchase" + ] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { "SHA256_RSA": { "type": "string" }, @@ -125048,27 +125375,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125078,7 +125385,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125088,7 +125395,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125098,412 +125405,156 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] - } - ] - }, - "secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "resolution_comment": { - "type": "string", - "description": "An optional comment to resolve an alert.", - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the detected secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - } - } - }, - "secret-scanning-alert-resolution-comment": { - "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", - "type": "string", - "nullable": true - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } - }, - "required": [ - "issue_title_url" ] }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "secret-scanning-alert": { "type": "object", "properties": { - "issue_body_url": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "pull_request_review_comment_url" - ] + } + }, + "secret-scanning-alert-resolution-comment": { + "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", + "type": "string", + "nullable": true }, "secret-scanning-location": { "type": "object", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index d85c2d5770..c056c7a912 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -72420,6 +72420,264 @@ components: - wont_fix - revoked - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true organization-secret-scanning-alert: type: object properties: @@ -72513,6 +72771,8 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" actor: title: Actor description: Actor @@ -92332,249 +92592,13 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index ba71abed70..bf171d60bd 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -99525,1100 +99525,890 @@ "used_in_tests" ] }, - "organization-secret-scanning-alert": { + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "url": { - "$ref": "#/components/schemas/alert-url" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, - "locations_url": { + "blob_sha": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "resolved_at": { + "blob_url": { "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "description": "The API URL to get the associated blob resource" }, - "secret_type": { + "commit_sha": { "type": "string", - "description": "The type of secret that secret scanning detected." + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "secret_type_display_name": { + "commit_url": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true + "description": "The file path of the wiki page", + "example": "/example/Home.md" }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_comment": { + "blob_sha": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "push_protection_bypass_request_html_url": { + "page_url": { "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "resolution_comment": { + "commit_sha": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "validity": { + "commit_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" } - } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] }, - "actor": { - "title": "Actor", - "description": "Actor", + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { + "issue_title_url": { "type": "string", - "format": "uri" + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" } }, "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" + "issue_title_url" ] }, - "nullable-milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", "type": "object", "properties": { - "url": { + "issue_body_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" }, - "open_issues": { - "type": "integer", - "example": 4 + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" }, - "closed_issues": { - "type": "integer", - "example": 8 + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" ], "nullable": true }, - "issue-type": { - "title": "Issue Type", - "description": "The type of issue.", + "organization-secret-scanning-alert": { "type": "object", - "nullable": true, "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." + "number": { + "$ref": "#/components/schemas/alert-number" }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." + "created_at": { + "$ref": "#/components/schemas/alert-created-at" }, - "name": { - "type": "string", - "description": "The name of the issue type." + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" }, - "description": { + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", - "description": "The description of the issue type.", - "nullable": true + "format": "uri", + "description": "The REST API URL of the code locations for this alert." }, - "color": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "updated_at": { + "secret_type": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" + "description": "The type of secret that secret scanning detected." }, - "node_id": { + "secret_type_display_name": { "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "client_id": { + "secret": { "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" + "description": "The secret that was detected." }, - "owner": { - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } - ] + "repository": { + "$ref": "#/components/schemas/simple-repository" }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true }, - "description": { + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "example": "The description of the app.", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "external_url": { + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "example": "https://example.com" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "html_url": { + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "example": "https://github.com/apps/super-ci" + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "created_at": { + "resolution_comment": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "description": "The comment that was optionally added when this alert was closed", + "nullable": true }, - "updated_at": { + "validity": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author-association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + } }, - "reaction-rollup": { - "title": "Reaction Rollup", + "actor": { + "title": "Actor", + "description": "Actor", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { + "id": { "type": "integer" }, - "confused": { - "type": "integer" + "login": { + "type": "string" }, - "heart": { - "type": "integer" + "display_login": { + "type": "string" }, - "hooray": { - "type": "integer" + "gravatar_id": { + "type": "string", + "nullable": true }, - "eyes": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "rocket": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri" } }, "required": [ + "id", + "login", + "gravatar_id", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "avatar_url" ] }, - "sub-issues-summary": { - "title": "Sub-issues Summary", + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { - "type": "string" - }, - "comments_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, - "events_url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "example": 1002604 }, - "html_url": { + "node_id": { "type": "string", - "format": "uri" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { + "creator": { "$ref": "#/components/schemas/nullable-simple-user" }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" + "open_issues": { + "type": "integer", + "example": 4 }, - "locked": { - "type": "boolean" + "closed_issues": { + "type": "integer", + "example": 8 }, - "active_lock_reason": { + "created_at": { "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", + "example": "2013-02-12T13:22:01Z", "nullable": true }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { + "due_on": { "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/issue-type" - }, - "repository": { - "$ref": "#/components/schemas/repository" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" - }, - "sub_issues_summary": { - "$ref": "#/components/schemas/sub-issues-summary" + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ - "assignee", + "closed_issues", + "creator", + "description", + "due_on", "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", "labels_url", - "milestone", + "html_url", "number", - "repository_url", + "open_issues", "state", - "locked", "title", "url", - "user", - "author_association", "created_at", "updated_at" - ] + ], + "nullable": true }, - "issue-comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", - "format": "int64" + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" + "description": "The node identifier of the issue type." }, - "body_html": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the issue type." }, - "html_url": { + "description": { "type": "string", - "format": "uri" + "description": "The description of the issue type.", + "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "description": "The time the issue type created.", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" + "name", + "description" ] }, - "event": { - "title": "Event", - "description": "Event", + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "type": { + "node_id": { "type": "string", - "nullable": true + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "actor": { - "$ref": "#/components/schemas/actor" + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/enterprise" } - }, - "required": [ - "id", - "name", - "url" ] }, - "org": { - "$ref": "#/components/schemas/actor" + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" }, - "payload": { + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "action": { + "issues": { "type": "string" }, - "issue": { - "$ref": "#/components/schemas/issue" + "checks": { + "type": "string" }, - "comment": { - "$ref": "#/components/schemas/issue-comment" + "metadata": { + "type": "string" }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "public": { - "type": "boolean" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "link-with-type": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" + "author-association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "feed": { - "title": "Feed", - "description": "Feed", + "reaction-rollup": { + "title": "Reaction Rollup", "type": "object", "properties": { - "timeline_url": { + "url": { "type": "string", - "example": "https://github.com/timeline" + "format": "uri" }, - "user_url": { - "type": "string", - "example": "https://github.com/{user}" + "total_count": { + "type": "integer" }, - "current_user_public_url": { - "type": "string", - "example": "https://github.com/octocat" + "+1": { + "type": "integer" }, - "current_user_url": { - "type": "string", - "example": "https://github.com/octocat.private?token=abc123" + "-1": { + "type": "integer" }, - "current_user_actor_url": { - "type": "string", - "example": "https://github.com/octocat.private.actor?token=abc123" + "laugh": { + "type": "integer" }, - "current_user_organization_url": { - "type": "string", - "example": "https://github.com/octocat-org" + "confused": { + "type": "integer" }, - "current_user_organization_urls": { - "type": "array", - "example": [ - "https://github.com/organizations/github/octocat.private.atom?token=abc123" - ], - "items": { - "type": "string", - "format": "uri" - } + "heart": { + "type": "integer" }, - "security_advisories_url": { - "type": "string", - "example": "https://github.com/security-advisories" + "hooray": { + "type": "integer" }, - "repository_discussions_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions", - "description": "A feed of discussions for a given repository." + "eyes": { + "type": "integer" }, - "repository_discussions_category_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", - "description": "A feed of discussions for a given repository and category." + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "_links": { - "type": "object", - "properties": { - "timeline": { - "$ref": "#/components/schemas/link-with-type" - }, - "user": { - "$ref": "#/components/schemas/link-with-type" - }, - "security_advisories": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_public": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_actor": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organization": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organizations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "repository_discussions": { - "$ref": "#/components/schemas/link-with-type" - }, - "repository_discussions_category": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "required": [ - "timeline", - "user" - ] + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" } }, "required": [ - "_links", - "timeline_url", - "user_url" + "total", + "completed", + "percent_completed" ] }, - "base-gist": { - "title": "Base Gist", - "description": "Base Gist", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "format": "int64" }, - "forks_url": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "commits_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "type": "string" - }, - "node_id": { + "labels_url": { "type": "string" }, - "git_pull_url": { + "comments_url": { "type": "string", "format": "uri" }, - "git_push_url": { + "events_url": { "type": "string", "format": "uri" }, @@ -100626,510 +100416,524 @@ "type": "string", "format": "uri" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" }, - "public": { - "type": "boolean" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" }, - "created_at": { + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", "type": "string", - "format": "date-time" + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned" + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" }, - "description": { + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "truncated": { - "type": "boolean" + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "forks": { + "assignees": { "type": "array", - "items": {} + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true }, - "history": { - "type": "array", - "items": {} + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", "user", - "files", + "author_association", "created_at", "updated_at" ] }, - "public-user": { - "title": "Public User", - "description": "Public User", + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, - "user_view_type": { - "type": "string" - }, "node_id": { "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "gists_url": { + "body_text": { "type": "string" }, - "starred_url": { + "body_html": { "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "events_url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "issue_url": { "type": "string", "format": "uri" }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - }, - "name": { - "type": "string", - "nullable": true + "author_association": { + "$ref": "#/components/schemas/author-association" }, - "company": { - "type": "string", - "nullable": true + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" }, - "blog": { - "type": "string", - "nullable": true - }, - "location": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "notification_email": { - "type": "string", - "format": "email", - "nullable": true - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" }, - "twitter_username": { + "type": { "type": "string", "nullable": true }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "actor": { + "$ref": "#/components/schemas/actor" }, - "plan": { + "repo": { "type": "object", "properties": { - "collaborators": { + "id": { "type": "integer" }, "name": { "type": "string" }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "collaborators", + "id", "name", - "space", - "private_repos" + "url" ] }, - "private_gists": { - "type": "integer", - "example": 1 - }, - "total_private_repos": { - "type": "integer", - "example": 2 + "org": { + "$ref": "#/components/schemas/actor" }, - "owned_private_repos": { - "type": "integer", - "example": 2 + "payload": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "comment": { + "$ref": "#/components/schemas/issue-comment" + }, + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + } }, - "disk_usage": { - "type": "integer", - "example": 1 + "public": { + "type": "boolean" }, - "collaborators": { - "type": "integer", - "example": 3 + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "actor", + "repo", + "payload", + "public", + "created_at" + ] }, - "gist-history": { - "title": "Gist History", - "description": "Gist History", + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", "type": "object", "properties": { - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "href": { + "type": "string" }, - "version": { + "type": { "type": "string" + } + }, + "required": [ + "href", + "type" + ] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" }, - "committed_at": { + "user_url": { "type": "string", - "format": "date-time" + "example": "https://github.com/{user}" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" }, - "url": { + "current_user_url": { "type": "string", - "format": "uri" - } - } - }, - "gist-simple": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "$ref": "#/components/schemas/public-user" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } + "example": "https://github.com/octocat.private?token=abc123" }, - "history": { - "deprecated": true, - "nullable": true, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], "items": { - "$ref": "#/components/schemas/gist-history" + "type": "string", + "format": "uri" } }, - "fork_of": { - "nullable": true, - "title": "Gist", - "description": "Gist", + "security_advisories_url": { + "type": "string", + "example": "https://github.com/security-advisories" + }, + "repository_discussions_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions", + "description": "A feed of discussions for a given repository." + }, + "repository_discussions_category_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", + "description": "A feed of discussions for a given repository and category." + }, + "_links": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" + "timeline": { + "$ref": "#/components/schemas/link-with-type" }, - "commits_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/link-with-type" }, - "id": { - "type": "string" + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" }, - "node_id": { - "type": "string" + "current_user": { + "$ref": "#/components/schemas/link-with-type" }, - "git_pull_url": { - "type": "string", - "format": "uri" + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" }, - "git_push_url": { - "type": "string", - "format": "uri" + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" }, - "html_url": { - "type": "string", - "format": "uri" + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } + "current_user_organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/link-with-type" } }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "repository_discussions": { + "$ref": "#/components/schemas/link-with-type" }, - "history": { - "type": "array", - "items": {} + "repository_discussions_category": { + "$ref": "#/components/schemas/link-with-type" } }, "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" + "timeline", + "user" ] - }, + } + }, + "required": [ + "_links", + "timeline_url", + "user_url" + ] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri" }, "forks_url": { - "type": "string" + "type": "string", + "format": "uri" }, "commits_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "string" @@ -101138,18 +100942,20 @@ "type": "string" }, "git_pull_url": { - "type": "string" + "type": "string", + "format": "uri" }, "git_push_url": { - "type": "string" + "type": "string", + "format": "uri" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "files": { "type": "object", "additionalProperties": { - "nullable": true, "type": "object", "properties": { "filename": { @@ -101167,12 +100973,6 @@ "size": { "type": "integer" }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", @@ -101185,10 +100985,12 @@ "type": "boolean" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "description": { "type": "string", @@ -101201,460 +101003,985 @@ "type": "boolean" }, "user": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/nullable-simple-user" }, "comments_url": { - "type": "string" + "type": "string", + "format": "uri" }, "owner": { "$ref": "#/components/schemas/simple-user" }, "truncated": { "type": "boolean" - } - } - }, - "gist-comment": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDExOkdpc3RDb21tZW50MQ==" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + "forks": { + "type": "array", + "items": {} }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535, - "example": "Body of the attachment" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" + "history": { + "type": "array", + "items": {} } }, "required": [ - "url", "id", "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", "user", - "body", - "author_association", + "files", "created_at", "updated_at" ] }, - "gist-commit": { - "title": "Gist Commit", - "description": "Gist Commit", + "public-user": { + "title": "Public User", + "description": "Public User", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + "login": { + "type": "string" }, - "version": { - "type": "string", - "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + "id": { + "type": "integer", + "format": "int64" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "user_view_type": { + "type": "string" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "node_id": { + "type": "string" }, - "committed_at": { - "type": "string", - "format": "date-time", - "example": "2010-04-14T02:15:15Z" - } - }, - "required": [ - "url", - "user", - "version", - "committed_at", - "change_status" - ] - }, - "gitignore-template": { - "title": "Gitignore Template", - "description": "Gitignore Template", - "type": "object", - "properties": { - "name": { + "avatar_url": { "type": "string", - "example": "C" + "format": "uri" }, - "source": { + "gravatar_id": { "type": "string", - "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" - } - }, - "required": [ - "name", - "source" - ] - }, - "license-simple": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { + "nullable": true + }, + "url": { "type": "string", - "example": "mit" + "format": "uri" }, - "name": { + "html_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { + "followers_url": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "format": "uri" }, - "spdx_id": { + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { "type": "string", - "nullable": true, - "example": "MIT" + "format": "uri" }, - "node_id": { + "organizations_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - }, - "license": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { + }, + "events_url": { + "type": "string" + }, + "received_events_url": { "type": "string", - "example": "mit" + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" }, "name": { "type": "string", - "example": "MIT License" + "nullable": true }, - "spdx_id": { + "company": { "type": "string", - "example": "MIT", "nullable": true }, - "url": { + "blog": { "type": "string", - "format": "uri", - "example": "https://api.github.com/licenses/mit", "nullable": true }, - "node_id": { + "location": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "nullable": true }, - "html_url": { + "email": { "type": "string", - "format": "uri", - "example": "http://choosealicense.com/licenses/mit/" + "format": "email", + "nullable": true }, - "description": { + "notification_email": { "type": "string", - "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + "format": "email", + "nullable": true }, - "implementation": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { "type": "string", - "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + "nullable": true }, - "permissions": { - "type": "array", - "example": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ], - "items": { - "type": "string" - } + "twitter_username": { + "type": "string", + "nullable": true }, - "conditions": { - "type": "array", - "example": [ - "include-copyright" - ], - "items": { - "type": "string" - } + "public_repos": { + "type": "integer" }, - "limitations": { - "type": "array", - "example": [ - "no-liability" - ], - "items": { - "type": "string" - } + "public_gists": { + "type": "integer" }, - "body": { + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { "type": "string", - "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + "format": "date-time" }, - "featured": { - "type": "boolean", - "example": true - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] - }, - "marketplace-listing-plan": { - "title": "Marketplace Listing Plan", - "description": "Marketplace Listing Plan", - "type": "object", - "properties": { - "url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313" + "format": "date-time" }, - "accounts_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] }, - "id": { + "private_gists": { "type": "integer", - "example": 1313 + "example": 1 }, - "number": { + "total_private_repos": { "type": "integer", - "example": 3 - }, - "name": { - "type": "string", - "example": "Pro" - }, - "description": { - "type": "string", - "example": "A professional-grade CI solution" + "example": 2 }, - "monthly_price_in_cents": { + "owned_private_repos": { "type": "integer", - "example": 1099 + "example": 2 }, - "yearly_price_in_cents": { + "disk_usage": { "type": "integer", - "example": 11870 - }, - "price_model": { - "type": "string", - "enum": [ - "FREE", - "FLAT_RATE", - "PER_UNIT" - ], - "example": "FLAT_RATE" - }, - "has_free_trial": { - "type": "boolean", - "example": true - }, - "unit_name": { - "type": "string", - "nullable": true - }, - "state": { - "type": "string", - "example": "published" + "example": 1 }, - "bullets": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "Up to 25 private repositories", - "11 concurrent builds" - ] + "collaborators": { + "type": "integer", + "example": 3 } }, "required": [ - "url", - "accounts_url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", "name", - "description", - "has_free_trial", - "price_model", - "unit_name", - "monthly_price_in_cents", - "state", - "yearly_price_in_cents", - "bullets" - ] + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false }, - "marketplace-purchase": { - "title": "Marketplace Purchase", - "description": "Marketplace Purchase", + "gist-history": { + "title": "Gist History", + "description": "Gist History", "type": "object", "properties": { - "url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "organization_billing_email": { + "version": { "type": "string" }, - "email": { + "committed_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "marketplace_pending_change": { + "change_status": { "type": "object", "properties": { - "is_installed": { - "type": "boolean" - }, - "effective_date": { - "type": "string" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "id": { + "total": { "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" - } - }, - "nullable": true - }, - "marketplace_purchase": { - "type": "object", - "properties": { - "billing_cycle": { - "type": "string" - }, - "next_billing_date": { - "type": "string", - "nullable": true - }, - "is_installed": { - "type": "boolean" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "on_free_trial": { - "type": "boolean" - }, - "free_trial_ends_on": { - "type": "string", - "nullable": true - }, - "updated_at": { - "type": "string" + "additions": { + "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" + "deletions": { + "type": "integer" } } + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "url", - "id", - "type", - "login", - "marketplace_purchase" - ] + } }, - "api-overview": { - "title": "Api Overview", - "description": "Api Overview", + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", "type": "object", "properties": { - "verifiable_password_authentication": { - "type": "boolean", - "example": true - }, - "ssh_key_fingerprints": { - "type": "object", - "properties": { + "forks": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/public-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "history": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-history" + } + }, + "fork_of": { + "nullable": true, + "title": "Gist", + "description": "Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + } + } + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": [ + "url", + "user", + "version", + "committed_at", + "change_status" + ] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "C" + }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": [ + "name", + "source" + ] + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "spdx_id": { + "type": "string", + "example": "MIT", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "example": [ + "include-copyright" + ], + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "example": [ + "no-liability" + ], + "items": { + "type": "string" + } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { + "type": "boolean", + "example": true + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { + "type": "integer", + "example": 1313 + }, + "number": { + "type": "integer", + "example": 3 + }, + "name": { + "type": "string", + "example": "Pro" + }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { + "type": "integer", + "example": 1099 + }, + "yearly_price_in_cents": { + "type": "integer", + "example": 11870 + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ], + "example": "FLAT_RATE" + }, + "has_free_trial": { + "type": "boolean", + "example": true + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "example": "published" + }, + "bullets": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "organization_billing_email": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true + }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { + "type": "boolean" + }, + "effective_date": { + "type": "string" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "id": { + "type": "integer" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { + "type": "string" + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "is_installed": { + "type": "boolean" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": [ + "url", + "id", + "type", + "login", + "marketplace_purchase" + ] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { "SHA256_RSA": { "type": "string" }, @@ -125048,27 +125375,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125078,7 +125385,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125088,7 +125395,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -125098,412 +125405,156 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] - } - ] - }, - "secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "resolution_comment": { - "type": "string", - "description": "An optional comment to resolve an alert.", - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the detected secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - } - } - }, - "secret-scanning-alert-resolution-comment": { - "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", - "type": "string", - "nullable": true - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } - }, - "required": [ - "issue_title_url" ] }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "secret-scanning-alert": { "type": "object", "properties": { - "issue_body_url": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "pull_request_review_comment_url" - ] + } + }, + "secret-scanning-alert-resolution-comment": { + "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", + "type": "string", + "nullable": true }, "secret-scanning-location": { "type": "object", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index d85c2d5770..c056c7a912 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -72420,6 +72420,264 @@ components: - wont_fix - revoked - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true organization-secret-scanning-alert: type: object properties: @@ -72513,6 +72771,8 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" actor: title: Actor description: Actor @@ -92332,249 +92592,13 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 8673583a3c..d32efd861e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -23044,6 +23044,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -137592,6 +137877,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -420417,6 +420987,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -421133,6 +421988,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, @@ -421802,6 +422942,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index fe1ca41cc1..efac9c7748 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1017,7 +1017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &586 + - &600 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9518,6 +9518,275 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &580 + - &582 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &583 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &584 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &585 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &586 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &587 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &588 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &589 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &590 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &591 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &592 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &593 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &594 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true examples: default: &257 value: @@ -10829,7 +11098,7 @@ paths: url: type: string format: uri - user: &609 + user: &623 title: Public User description: Public User type: object @@ -15317,7 +15586,7 @@ paths: - avatar_url - description examples: - default: &627 + default: &641 value: - login: github id: 1 @@ -15582,7 +15851,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *94 - - &650 + - &664 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -15591,7 +15860,7 @@ paths: required: false schema: type: integer - - &651 + - &665 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -15600,7 +15869,7 @@ paths: required: false schema: type: integer - - &652 + - &666 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -15609,7 +15878,7 @@ paths: required: false schema: type: integer - - &653 + - &667 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -17403,7 +17672,7 @@ paths: type: array items: *60 examples: - default: &621 + default: &635 value: total_count: 1 repositories: @@ -18271,7 +18540,7 @@ paths: type: array items: *120 examples: - default: &612 + default: &626 value: total_count: 1 repositories: @@ -29735,7 +30004,7 @@ paths: parameters: - *94 - *207 - - &626 + - &640 name: repo_name description: repo_name parameter in: path @@ -30763,7 +31032,7 @@ paths: - nuget - container - *94 - - &628 + - &642 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -30804,7 +31073,7 @@ paths: default: *215 '403': *29 '401': *25 - '400': &630 + '400': &644 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -36449,7 +36718,7 @@ paths: application/json: schema: type: array - items: &584 + items: &598 description: A repository security advisory. type: object properties: @@ -36740,7 +37009,7 @@ paths: - private_fork additionalProperties: false examples: - default: &585 + default: &599 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -37214,7 +37483,7 @@ paths: description: Response content: application/json: - schema: &644 + schema: &658 type: object properties: total_minutes_used: @@ -37284,7 +37553,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &645 + default: &659 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -37320,7 +37589,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &660 type: object properties: total_gigabytes_bandwidth_used: @@ -37338,7 +37607,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &647 + default: &661 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -37370,7 +37639,7 @@ paths: description: Response content: application/json: - schema: &648 + schema: &662 type: object properties: days_left_in_billing_cycle: @@ -37388,7 +37657,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &649 + default: &663 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -38599,7 +38868,7 @@ paths: - updated_at - url examples: - default: &599 + default: &613 value: - author: login: octocat @@ -38847,7 +39116,7 @@ paths: application/json: schema: *268 examples: - default: &600 + default: &614 value: author: login: octocat @@ -39030,7 +39299,7 @@ paths: - updated_at - url examples: - default: &601 + default: &615 value: - author: login: octocat @@ -39256,7 +39525,7 @@ paths: application/json: schema: *271 examples: - default: &602 + default: &616 value: author: login: octocat @@ -39872,7 +40141,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &603 + response-if-user-is-a-team-maintainer: &617 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -39937,7 +40206,7 @@ paths: application/json: schema: *278 examples: - response-if-users-membership-with-team-is-now-pending: &604 + response-if-users-membership-with-team-is-now-pending: &618 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40078,7 +40347,7 @@ paths: - updated_at - permissions examples: - default: &605 + default: &619 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40157,7 +40426,7 @@ paths: application/json: schema: *279 examples: - default: &606 + default: &620 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40367,7 +40636,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &607 + schema: &621 title: Team Repository description: A team's access to a repository. type: object @@ -41024,7 +41293,7 @@ paths: type: array items: *152 examples: - response-if-child-teams-exist: &608 + response-if-child-teams-exist: &622 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -52853,7 +53122,7 @@ paths: check. type: array items: *360 - deployment: &662 + deployment: &676 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -53765,7 +54034,7 @@ paths: type: string format: date-time nullable: true - head_commit: &688 + head_commit: &702 title: Simple Commit description: A commit. type: object @@ -57985,14 +58254,14 @@ paths: type: integer machines: type: array - items: &615 + items: &629 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *402 required: *403 examples: - default: &616 + default: &630 value: total_count: 2 machines: @@ -61292,7 +61561,7 @@ paths: application/json: schema: type: array - items: &589 + items: &603 title: Status description: The status of a commit. type: object @@ -62848,7 +63117,7 @@ paths: items: type: object properties: - placeholder_id: &581 + placeholder_id: &595 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68601,7 +68870,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &696 + last_response: &710 title: Hook Response type: object properties: @@ -69561,7 +69830,7 @@ paths: parameters: - *281 - *282 - - &639 + - &653 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -69995,7 +70264,7 @@ paths: type: array items: *477 examples: - default: &632 + default: &646 value: - id: 1 repository: @@ -83675,7 +83944,7 @@ paths: application/json: schema: type: array - items: &580 + items: &581 type: object properties: number: *54 @@ -83785,6 +84054,14 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *580 + nullable: true examples: default: value: @@ -83922,7 +84199,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -84003,7 +84280,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -84091,7 +84368,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &717 + items: &731 type: object properties: type: @@ -84117,254 +84394,19 @@ paths: example: commit details: oneOf: - - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url + - *582 + - *583 + - *584 + - *585 + - *586 + - *587 + - *588 + - *589 + - *590 + - *591 + - *592 + - *593 + - *594 examples: default: value: @@ -84459,14 +84501,14 @@ paths: schema: type: object properties: - reason: &582 + reason: &596 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *581 + placeholder_id: *595 required: - reason - placeholder_id @@ -84483,7 +84525,7 @@ paths: schema: type: object properties: - reason: *582 + reason: *596 expire_at: type: string format: date-time @@ -84542,7 +84584,7 @@ paths: properties: incremental_scans: type: array - items: &583 + items: &597 description: Information on a single scan performed by secret scanning on the repository type: object @@ -84568,15 +84610,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *583 + items: *597 backfill_scans: type: array - items: *583 + items: *597 custom_pattern_backfill_scans: type: array items: allOf: - - *583 + - *597 - type: object properties: pattern_name: @@ -84691,9 +84733,9 @@ paths: application/json: schema: type: array - items: *584 + items: *598 examples: - default: *585 + default: *599 '400': *14 '404': *6 x-github: @@ -84877,9 +84919,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: &587 + default: &601 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -85217,7 +85259,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: default: value: @@ -85366,15 +85408,15 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '200': description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: *587 + default: *601 '403': *29 '404': *6 x-github: @@ -85400,7 +85442,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 requestBody: required: true content: @@ -85559,10 +85601,10 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: *587 - add_credit: *587 + default: *601 + add_credit: *601 '403': *29 '404': *6 '422': @@ -85602,7 +85644,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '202': *39 '400': *14 @@ -85631,7 +85673,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '202': description: Response @@ -85775,7 +85817,7 @@ paths: application/json: schema: type: array - items: &588 + items: &602 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -86148,7 +86190,7 @@ paths: application/json: schema: type: array - items: *588 + items: *602 examples: default: value: @@ -86236,7 +86278,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *603 examples: default: value: @@ -86330,7 +86372,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &590 + schema: &604 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -86425,7 +86467,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *604 examples: default: value: @@ -86562,7 +86604,7 @@ paths: application/json: schema: type: array - items: &591 + items: &605 title: Tag protection description: Tag protection type: object @@ -86638,7 +86680,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *605 examples: default: value: @@ -86786,7 +86828,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &606 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -86798,7 +86840,7 @@ paths: required: - names examples: - default: &593 + default: &607 value: names: - octocat @@ -86853,9 +86895,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *606 examples: - default: *593 + default: *607 '404': *6 '422': *7 x-github: @@ -86878,7 +86920,7 @@ paths: parameters: - *281 - *282 - - &594 + - &608 name: per description: The time frame to display results for. in: query @@ -86907,7 +86949,7 @@ paths: example: 128 clones: type: array - items: &595 + items: &609 title: Traffic type: object properties: @@ -87148,7 +87190,7 @@ paths: parameters: - *281 - *282 - - *594 + - *608 responses: '200': description: Response @@ -87167,7 +87209,7 @@ paths: example: 3782 views: type: array - items: *595 + items: *609 required: - uniques - count @@ -87936,7 +87978,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &596 + text_matches: &610 title: Search Result Text Matches type: array items: @@ -88098,7 +88140,7 @@ paths: enum: - author-date - committer-date - - &597 + - &611 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -88226,7 +88268,7 @@ paths: type: number node_id: type: string - text_matches: *596 + text_matches: *610 required: - sha - node_id @@ -88408,7 +88450,7 @@ paths: - interactions - created - updated - - *597 + - *611 - *17 - *19 - name: advanced_search @@ -88550,7 +88592,7 @@ paths: type: string format: date-time nullable: true - text_matches: *596 + text_matches: *610 pull_request: type: object properties: @@ -88778,7 +88820,7 @@ paths: enum: - created - updated - - *597 + - *611 - *17 - *19 responses: @@ -88822,7 +88864,7 @@ paths: nullable: true score: type: number - text_matches: *596 + text_matches: *610 required: - id - node_id @@ -88907,7 +88949,7 @@ paths: - forks - help-wanted-issues - updated - - *597 + - *611 - *17 - *19 responses: @@ -89146,7 +89188,7 @@ paths: - admin - pull - push - text_matches: *596 + text_matches: *610 temp_clone_token: type: string allow_merge_commit: @@ -89446,7 +89488,7 @@ paths: type: string format: uri nullable: true - text_matches: *596 + text_matches: *610 related: type: array nullable: true @@ -89637,7 +89679,7 @@ paths: - followers - repositories - joined - - *597 + - *611 - *17 - *19 responses: @@ -89741,7 +89783,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *596 + text_matches: *610 blog: type: string nullable: true @@ -89820,7 +89862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &598 + - &612 name: team_id description: The unique identifier of the team. in: path @@ -89861,7 +89903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *598 + - *612 requestBody: required: true content: @@ -89961,7 +90003,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *598 + - *612 responses: '204': description: Response @@ -89992,7 +90034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *598 + - *612 - *48 - *17 - *19 @@ -90005,7 +90047,7 @@ paths: type: array items: *268 examples: - default: *599 + default: *613 headers: Link: *58 x-github: @@ -90034,7 +90076,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *598 + - *612 requestBody: required: true content: @@ -90097,7 +90139,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *598 + - *612 - *270 responses: '200': @@ -90131,7 +90173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *598 + - *612 - *270 requestBody: required: false @@ -90157,7 +90199,7 @@ paths: application/json: schema: *268 examples: - default: *600 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90182,7 +90224,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *598 + - *612 - *270 responses: '204': @@ -90212,7 +90254,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *598 + - *612 - *270 - *48 - *17 @@ -90226,7 +90268,7 @@ paths: type: array items: *271 examples: - default: *601 + default: *615 headers: Link: *58 x-github: @@ -90255,7 +90297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 requestBody: required: true @@ -90307,7 +90349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 responses: @@ -90342,7 +90384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 requestBody: @@ -90368,7 +90410,7 @@ paths: application/json: schema: *271 examples: - default: *602 + default: *616 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90393,7 +90435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 responses: @@ -90424,7 +90466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 - name: content @@ -90483,7 +90525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 requestBody: @@ -90545,7 +90587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *598 + - *612 - *270 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -90603,7 +90645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *598 + - *612 - *270 requestBody: required: true @@ -90662,7 +90704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -90700,7 +90742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *598 + - *612 - name: role description: Filters members returned by their role in the team. in: query @@ -90751,7 +90793,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90788,7 +90830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90828,7 +90870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90865,7 +90907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 responses: '200': @@ -90874,7 +90916,7 @@ paths: application/json: schema: *278 examples: - response-if-user-is-a-team-maintainer: *603 + response-if-user-is-a-team-maintainer: *617 '404': *6 x-github: githubCloudOnly: false @@ -90907,7 +90949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 requestBody: required: false @@ -90935,7 +90977,7 @@ paths: application/json: schema: *278 examples: - response-if-users-membership-with-team-is-now-pending: *604 + response-if-users-membership-with-team-is-now-pending: *618 '403': description: Forbidden if team synchronization is set up '422': @@ -90969,7 +91011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90998,7 +91040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91010,7 +91052,7 @@ paths: type: array items: *279 examples: - default: *605 + default: *619 headers: Link: *58 '404': *6 @@ -91036,7 +91078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *598 + - *612 - *280 responses: '200': @@ -91045,7 +91087,7 @@ paths: application/json: schema: *279 examples: - default: *606 + default: *620 '404': description: Not Found if project is not managed by this team x-github: @@ -91069,7 +91111,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *598 + - *612 - *280 requestBody: required: false @@ -91137,7 +91179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *598 + - *612 - *280 responses: '204': @@ -91165,7 +91207,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91207,7 +91249,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *598 + - *612 - *281 - *282 responses: @@ -91215,7 +91257,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *607 + schema: *621 examples: alternative-response-with-extra-repository-information: value: @@ -91366,7 +91408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *598 + - *612 - *281 - *282 requestBody: @@ -91418,7 +91460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *598 + - *612 - *281 - *282 responses: @@ -91445,7 +91487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91457,7 +91499,7 @@ paths: type: array items: *152 examples: - response-if-child-teams-exist: *608 + response-if-child-teams-exist: *622 headers: Link: *58 '404': *6 @@ -91490,7 +91532,7 @@ paths: application/json: schema: oneOf: - - &610 + - &624 title: Private User description: Private User type: object @@ -91693,7 +91735,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *609 + - *623 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -91846,7 +91888,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *624 examples: default: value: @@ -92244,7 +92286,7 @@ paths: type: integer secrets: type: array - items: &611 + items: &625 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -92360,7 +92402,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *625 examples: default: value: @@ -92506,7 +92548,7 @@ paths: type: array items: *120 examples: - default: *612 + default: *626 '401': *25 '403': *29 '404': *6 @@ -92773,7 +92815,7 @@ paths: description: Response content: application/json: - schema: &613 + schema: &627 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -92814,7 +92856,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &614 + default: &628 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -92859,9 +92901,9 @@ paths: description: Response content: application/json: - schema: *613 + schema: *627 examples: - default: *614 + default: *628 '404': *6 x-github: githubCloudOnly: false @@ -92898,9 +92940,9 @@ paths: type: integer machines: type: array - items: *615 + items: *629 examples: - default: *616 + default: *630 '304': *37 '500': *95 '401': *25 @@ -93839,7 +93881,7 @@ paths: type: array items: *214 examples: - default: &629 + default: &643 value: - id: 197 name: hello_docker @@ -93940,7 +93982,7 @@ paths: application/json: schema: type: array - items: &617 + items: &631 title: Email description: Email type: object @@ -94005,9 +94047,9 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: - default: &631 + default: &645 value: - email: octocat@github.com verified: true @@ -94082,7 +94124,7 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: default: value: @@ -94338,7 +94380,7 @@ paths: application/json: schema: type: array - items: &618 + items: &632 title: GPG Key description: A unique encryption key type: object @@ -94469,7 +94511,7 @@ paths: - subkeys - revoked examples: - default: &642 + default: &656 value: - id: 3 name: Octocat's GPG Key @@ -94554,9 +94596,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *632 examples: - default: &619 + default: &633 value: id: 3 name: Octocat's GPG Key @@ -94613,7 +94655,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &620 + - &634 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -94625,9 +94667,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *632 examples: - default: *619 + default: *633 '404': *6 '304': *37 '403': *29 @@ -94650,7 +94692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *620 + - *634 responses: '204': description: Response @@ -94841,7 +94883,7 @@ paths: type: array items: *60 examples: - default: *621 + default: *635 headers: Link: *58 '404': *6 @@ -95105,7 +95147,7 @@ paths: application/json: schema: type: array - items: &622 + items: &636 title: Key description: Key type: object @@ -95202,9 +95244,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *636 examples: - default: &623 + default: &637 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -95243,9 +95285,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *636 examples: - default: *623 + default: *637 '404': *6 '304': *37 '403': *29 @@ -95301,7 +95343,7 @@ paths: application/json: schema: type: array - items: &624 + items: &638 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -95369,7 +95411,7 @@ paths: - account - plan examples: - default: &625 + default: &639 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -95431,9 +95473,9 @@ paths: application/json: schema: type: array - items: *624 + items: *638 examples: - default: *625 + default: *639 headers: Link: *58 '304': *37 @@ -96428,7 +96470,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *207 - - *626 + - *640 responses: '204': description: Response @@ -96501,7 +96543,7 @@ paths: type: array items: *203 examples: - default: *627 + default: *641 headers: Link: *58 '304': *37 @@ -96543,7 +96585,7 @@ paths: - docker - nuget - container - - *628 + - *642 - *19 - *17 responses: @@ -96555,8 +96597,8 @@ paths: type: array items: *214 examples: - default: *629 - '400': *630 + default: *643 + '400': *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96585,7 +96627,7 @@ paths: application/json: schema: *214 examples: - default: &643 + default: &657 value: id: 40201 name: octo-name @@ -97038,9 +97080,9 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: - default: *631 + default: *645 headers: Link: *58 '304': *37 @@ -97153,7 +97195,7 @@ paths: type: array items: *60 examples: - default: &638 + default: &652 summary: Default response value: - id: 1296269 @@ -97499,7 +97541,7 @@ paths: type: array items: *477 examples: - default: *632 + default: *646 headers: Link: *58 '304': *37 @@ -97578,7 +97620,7 @@ paths: application/json: schema: type: array - items: &633 + items: &647 title: Social account description: Social media account type: object @@ -97593,7 +97635,7 @@ paths: - provider - url examples: - default: &634 + default: &648 value: - provider: twitter url: https://twitter.com/github @@ -97655,9 +97697,9 @@ paths: application/json: schema: type: array - items: *633 + items: *647 examples: - default: *634 + default: *648 '422': *15 '304': *37 '404': *6 @@ -97744,7 +97786,7 @@ paths: application/json: schema: type: array - items: &635 + items: &649 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -97764,7 +97806,7 @@ paths: - title - created_at examples: - default: &654 + default: &668 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -97830,9 +97872,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *649 examples: - default: &636 + default: &650 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -97863,7 +97905,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &637 + - &651 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -97875,9 +97917,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *649 examples: - default: *636 + default: *650 '404': *6 '304': *37 '403': *29 @@ -97900,7 +97942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *637 + - *651 responses: '204': description: Response @@ -97929,7 +97971,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &655 + - &669 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -97954,11 +97996,11 @@ paths: type: array items: *60 examples: - default-response: *638 + default-response: *652 application/vnd.github.v3.star+json: schema: type: array - items: &656 + items: &670 title: Starred Repository description: Starred Repository type: object @@ -98327,10 +98369,10 @@ paths: application/json: schema: oneOf: - - *610 - - *609 + - *624 + - *623 examples: - default-response: &640 + default-response: &654 summary: Default response value: login: octocat @@ -98365,7 +98407,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &641 + response-with-git-hub-plan-information: &655 summary: Response with GitHub plan information value: login: octocat @@ -98425,7 +98467,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *639 + - *653 - *17 responses: '200': @@ -98474,11 +98516,11 @@ paths: application/json: schema: oneOf: - - *610 - - *609 + - *624 + - *623 examples: - default-response: *640 - response-with-git-hub-plan-information: *641 + default-response: *654 + response-with-git-hub-plan-information: *655 '404': *6 x-github: githubCloudOnly: false @@ -98595,7 +98637,7 @@ paths: type: array items: *214 examples: - default: *629 + default: *643 '403': *29 '401': *25 x-github: @@ -98999,9 +99041,9 @@ paths: application/json: schema: type: array - items: *618 + items: *632 examples: - default: *642 + default: *656 headers: Link: *58 x-github: @@ -99183,7 +99225,7 @@ paths: type: array items: *203 examples: - default: *627 + default: *641 headers: Link: *58 x-github: @@ -99222,7 +99264,7 @@ paths: - docker - nuget - container - - *628 + - *642 - *133 - *19 - *17 @@ -99235,10 +99277,10 @@ paths: type: array items: *214 examples: - default: *629 + default: *643 '403': *29 '401': *25 - '400': *630 + '400': *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99268,7 +99310,7 @@ paths: application/json: schema: *214 examples: - default: *643 + default: *657 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99867,9 +99909,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *658 examples: - default: *645 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99897,9 +99939,9 @@ paths: description: Response content: application/json: - schema: *646 + schema: *660 examples: - default: *647 + default: *661 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99927,9 +99969,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *662 examples: - default: *649 + default: *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99950,10 +99992,10 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *133 - - *650 - - *651 - - *652 - - *653 + - *664 + - *665 + - *666 + - *667 responses: '200': description: Response when getting a billing usage report @@ -100052,9 +100094,9 @@ paths: application/json: schema: type: array - items: *633 + items: *647 examples: - default: *634 + default: *648 headers: Link: *58 x-github: @@ -100084,9 +100126,9 @@ paths: application/json: schema: type: array - items: *635 + items: *649 examples: - default: *654 + default: *668 headers: Link: *58 x-github: @@ -100111,7 +100153,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *133 - - *655 + - *669 - *48 - *17 - *19 @@ -100123,11 +100165,11 @@ paths: schema: anyOf: - type: array - items: *656 + items: *670 - type: array items: *60 examples: - default-response: *638 + default-response: *652 headers: Link: *58 x-github: @@ -100286,7 +100328,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &657 + enterprise: &671 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -100344,7 +100386,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &658 + installation: &672 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -100363,7 +100405,7 @@ x-webhooks: required: - id - node_id - organization: &659 + organization: &673 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -100423,13 +100465,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &660 + repository: &674 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &690 + properties: &704 id: description: Unique identifier of the repository example: 42 @@ -101112,7 +101154,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &691 + required: &705 - archive_url - assignees_url - blobs_url @@ -101263,10 +101305,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -101342,11 +101384,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: &661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: &675 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -101569,11 +101611,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: *661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: *675 sender: *4 required: - action @@ -101756,11 +101798,11 @@ x-webhooks: - everyone required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: *661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: *675 sender: *4 required: - action @@ -101844,7 +101886,7 @@ x-webhooks: type: string enum: - completed - check_run: &663 + check_run: &677 title: CheckRun description: A check performed on the code of a given code change type: object @@ -101945,7 +101987,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *662 + deployment: *676 details_url: example: https://example.com type: string @@ -102030,9 +102072,9 @@ x-webhooks: - output - app - pull_requests - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -102425,10 +102467,10 @@ x-webhooks: type: string enum: - created - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -102824,10 +102866,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 requested_action: description: The action requested by the user. type: object @@ -103232,10 +103274,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -104212,10 +104254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -104885,10 +104927,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -105552,10 +105594,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -105863,20 +105905,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &664 + commit_oid: &678 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *657 - installation: *658 - organization: *659 - ref: &665 + enterprise: *671 + installation: *672 + organization: *673 + ref: &679 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -106268,12 +106310,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -106536,12 +106578,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -106870,12 +106912,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -107140,16 +107182,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *660 + repository: *674 sender: *4 required: - action @@ -107383,12 +107425,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -107645,10 +107687,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -107728,18 +107770,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *659 - pusher_type: &666 + organization: *673 + pusher_type: &680 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &667 + ref: &681 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -107749,7 +107791,7 @@ x-webhooks: enum: - tag - branch - repository: *660 + repository: *674 sender: *4 required: - ref @@ -107832,9 +107874,9 @@ x-webhooks: enum: - created definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -107919,9 +107961,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -107999,9 +108041,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -108079,9 +108121,9 @@ x-webhooks: enum: - updated definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -108158,10 +108200,10 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - repository: *660 - organization: *659 + enterprise: *671 + installation: *672 + repository: *674 + organization: *673 sender: *4 new_property_values: type: array @@ -108246,18 +108288,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - pusher_type: *666 - ref: *667 + enterprise: *671 + installation: *672 + organization: *673 + pusher_type: *680 + ref: *681 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *660 + repository: *674 sender: *4 required: - ref @@ -108342,10 +108384,10 @@ x-webhooks: enum: - auto_dismissed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108430,10 +108472,10 @@ x-webhooks: enum: - auto_reopened alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108518,10 +108560,10 @@ x-webhooks: enum: - created alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108604,10 +108646,10 @@ x-webhooks: enum: - dismissed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108690,10 +108732,10 @@ x-webhooks: enum: - fixed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108777,10 +108819,10 @@ x-webhooks: enum: - reintroduced alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108863,10 +108905,10 @@ x-webhooks: enum: - reopened alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108943,9 +108985,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - key: &668 + enterprise: *671 + installation: *672 + key: &682 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -108981,8 +109023,8 @@ x-webhooks: - verified - created_at - read_only - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -109059,11 +109101,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - key: *668 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + key: *682 + organization: *673 + repository: *674 sender: *4 required: - action @@ -109624,12 +109666,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: &672 + workflow: &686 title: Workflow type: object nullable: true @@ -110359,9 +110401,9 @@ x-webhooks: pull_requests: type: array items: *524 - repository: *660 - organization: *659 - installation: *658 + repository: *674 + organization: *673 + installation: *672 sender: *4 responses: '200': @@ -110432,7 +110474,7 @@ x-webhooks: type: string enum: - approved - approver: &669 + approver: &683 type: object properties: avatar_url: @@ -110475,11 +110517,11 @@ x-webhooks: type: string comment: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - reviewers: &670 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + reviewers: &684 type: array items: type: object @@ -110558,7 +110600,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &671 + workflow_job_run: &685 type: object properties: conclusion: @@ -111289,18 +111331,18 @@ x-webhooks: type: string enum: - rejected - approver: *669 + approver: *683 comment: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - reviewers: *670 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + reviewers: *684 sender: *4 since: type: string - workflow_job_run: *671 + workflow_job_run: *685 workflow_job_runs: type: array items: @@ -112004,13 +112046,13 @@ x-webhooks: type: string enum: - requested - enterprise: *657 + enterprise: *671 environment: type: string - installation: *658 - organization: *659 - repository: *660 - requestor: &677 + installation: *672 + organization: *673 + repository: *674 + requestor: &691 title: User type: object nullable: true @@ -113909,12 +113951,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Deployment Workflow Run type: object @@ -114594,7 +114636,7 @@ x-webhooks: type: string enum: - answered - answer: &675 + answer: &689 type: object properties: author_association: @@ -114751,7 +114793,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &673 + discussion: &687 title: Discussion description: A Discussion in a repository. type: object @@ -115059,10 +115101,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115189,11 +115231,11 @@ x-webhooks: - from required: - category - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115276,11 +115318,11 @@ x-webhooks: type: string enum: - closed - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115362,7 +115404,7 @@ x-webhooks: type: string enum: - created - comment: &674 + comment: &688 type: object properties: author_association: @@ -115519,11 +115561,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115606,12 +115648,12 @@ x-webhooks: type: string enum: - deleted - comment: *674 - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + comment: *688 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115706,12 +115748,12 @@ x-webhooks: - from required: - body - comment: *674 - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + comment: *688 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115795,11 +115837,11 @@ x-webhooks: type: string enum: - created - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115881,11 +115923,11 @@ x-webhooks: type: string enum: - deleted - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115985,11 +116027,11 @@ x-webhooks: type: string required: - from - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116071,10 +116113,10 @@ x-webhooks: type: string enum: - labeled - discussion: *673 - enterprise: *657 - installation: *658 - label: &676 + discussion: *687 + enterprise: *671 + installation: *672 + label: &690 title: Label type: object properties: @@ -116106,8 +116148,8 @@ x-webhooks: - color - default - description - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116190,11 +116232,11 @@ x-webhooks: type: string enum: - locked - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116276,11 +116318,11 @@ x-webhooks: type: string enum: - pinned - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116362,11 +116404,11 @@ x-webhooks: type: string enum: - reopened - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116451,16 +116493,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *673 - new_repository: *660 + new_discussion: *687 + new_repository: *674 required: - new_discussion - new_repository - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116543,10 +116585,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *673 - old_answer: *675 - organization: *659 - repository: *660 + discussion: *687 + old_answer: *689 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116628,12 +116670,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *673 - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116716,11 +116758,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116802,11 +116844,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116879,7 +116921,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *657 + enterprise: *671 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -117539,9 +117581,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - forkee @@ -117687,9 +117729,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pages: description: The pages that were updated. type: array @@ -117726,7 +117768,7 @@ x-webhooks: - action - sha - html_url - repository: *660 + repository: *674 sender: *4 required: - pages @@ -117802,10 +117844,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: &678 + organization: *673 + repositories: &692 description: An array of repository objects that the installation can access. type: array @@ -117831,8 +117873,8 @@ x-webhooks: - name - full_name - private - repository: *660 - requester: *677 + repository: *674 + requester: *691 sender: *4 required: - action @@ -117907,11 +117949,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -117987,11 +118029,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118067,10 +118109,10 @@ x-webhooks: type: string enum: - added - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories_added: &679 + organization: *673 + repositories_added: &693 description: An array of repository objects, which were added to the installation. type: array @@ -118116,15 +118158,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *660 - repository_selection: &680 + repository: *674 + repository_selection: &694 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *677 + requester: *691 sender: *4 required: - action @@ -118203,10 +118245,10 @@ x-webhooks: type: string enum: - removed - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories_added: *679 + organization: *673 + repositories_added: *693 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -118233,9 +118275,9 @@ x-webhooks: - name - full_name - private - repository: *660 - repository_selection: *680 - requester: *677 + repository: *674 + repository_selection: *694 + requester: *691 sender: *4 required: - action @@ -118314,11 +118356,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118496,10 +118538,10 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 target_type: type: string @@ -118578,11 +118620,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118834,8 +118876,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119991,8 +120033,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -120072,7 +120114,7 @@ x-webhooks: type: string enum: - deleted - comment: &681 + comment: &695 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -120237,8 +120279,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121392,8 +121434,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -121473,7 +121515,7 @@ x-webhooks: type: string enum: - edited - changes: &709 + changes: &723 description: The changes to the comment. type: object properties: @@ -121485,9 +121527,9 @@ x-webhooks: type: string required: - from - comment: *681 - enterprise: *657 - installation: *658 + comment: *695 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -122642,8 +122684,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -122725,10 +122767,10 @@ x-webhooks: type: string enum: - assigned - assignee: *677 - enterprise: *657 - installation: *658 - issue: &684 + assignee: *691 + enterprise: *671 + installation: *672 + issue: &698 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -123647,8 +123689,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -123728,8 +123770,8 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -124788,8 +124830,8 @@ x-webhooks: required: - state - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -124868,8 +124910,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125783,8 +125825,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -125863,8 +125905,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126779,7 +126821,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &682 + milestone: &696 title: Milestone description: A collection of related issues and pull requests. type: object @@ -126917,8 +126959,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -127017,8 +127059,8 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127937,9 +127979,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *676 - organization: *659 - repository: *660 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -128019,8 +128061,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128938,9 +128980,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *676 - organization: *659 - repository: *660 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -129020,8 +129062,8 @@ x-webhooks: type: string enum: - locked - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129940,8 +129982,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -130020,8 +130062,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -130934,9 +130976,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *682 - organization: *659 - repository: *660 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -132379,8 +132421,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133298,8 +133340,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -133379,9 +133421,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *657 - installation: *658 - issue: &683 + enterprise: *671 + installation: *672 + issue: &697 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -134293,8 +134335,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -134373,8 +134415,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135292,8 +135334,8 @@ x-webhooks: user_view_type: type: string type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136756,11 +136798,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *657 - installation: *658 - issue: *683 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *697 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136840,12 +136882,12 @@ x-webhooks: type: string enum: - typed - enterprise: *657 - installation: *658 - issue: *684 + enterprise: *671 + installation: *672 + issue: *698 type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136926,7 +136968,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &712 + assignee: &726 title: User type: object nullable: true @@ -136996,11 +137038,11 @@ x-webhooks: required: - login - id - enterprise: *657 - installation: *658 - issue: *684 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *698 + organization: *673 + repository: *674 sender: *4 required: - action @@ -137079,12 +137121,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *657 - installation: *658 - issue: *684 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *698 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -137164,8 +137206,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138082,8 +138124,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138163,11 +138205,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *657 - installation: *658 - issue: *683 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *697 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138246,12 +138288,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *657 - installation: *658 - issue: *684 + enterprise: *671 + installation: *672 + issue: *698 type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138331,11 +138373,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138413,11 +138455,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138527,11 +138569,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138613,9 +138655,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: &685 + enterprise: *671 + installation: *672 + marketplace_purchase: &699 title: Marketplace Purchase type: object required: @@ -138698,8 +138740,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *659 - previous_marketplace_purchase: &686 + organization: *673 + previous_marketplace_purchase: &700 title: Marketplace Purchase type: object properties: @@ -138779,7 +138821,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -138859,10 +138901,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -138945,7 +138987,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -139027,10 +139069,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -139112,7 +139154,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -139193,8 +139235,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 marketplace_purchase: title: Marketplace Purchase type: object @@ -139276,9 +139318,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *659 - previous_marketplace_purchase: *686 - repository: *660 + organization: *673 + previous_marketplace_purchase: *700 + repository: *674 sender: *4 required: - action @@ -139358,12 +139400,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 - previous_marketplace_purchase: *686 - repository: *660 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 + previous_marketplace_purchase: *700 + repository: *674 sender: *4 required: - action @@ -139465,11 +139507,11 @@ x-webhooks: type: string required: - to - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139569,11 +139611,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139652,11 +139694,11 @@ x-webhooks: type: string enum: - removed - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139734,11 +139776,11 @@ x-webhooks: type: string enum: - added - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 scope: description: The scope of the membership. Currently, can only be `team`. @@ -139814,7 +139856,7 @@ x-webhooks: required: - login - id - team: &687 + team: &701 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -140004,11 +140046,11 @@ x-webhooks: type: string enum: - removed - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 scope: description: The scope of the membership. Currently, can only be `team`. @@ -140085,7 +140127,7 @@ x-webhooks: required: - login - id - team: *687 + team: *701 required: - action - scope @@ -140167,8 +140209,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *658 - merge_group: &689 + installation: *672 + merge_group: &703 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -140187,15 +140229,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *688 + head_commit: *702 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140281,10 +140323,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *658 - merge_group: *689 - organization: *659 - repository: *660 + installation: *672 + merge_group: *703 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140357,7 +140399,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 + enterprise: *671 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -140465,16 +140507,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *658 - organization: *659 + installation: *672 + organization: *673 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -140555,11 +140597,11 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140638,9 +140680,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - milestone: &692 + enterprise: *671 + installation: *672 + milestone: &706 title: Milestone description: A collection of related issues and pull requests. type: object @@ -140777,8 +140819,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140857,11 +140899,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140971,11 +141013,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141055,11 +141097,11 @@ x-webhooks: type: string enum: - opened - enterprise: *657 - installation: *658 - milestone: *692 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *706 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141138,11 +141180,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *677 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + blocked_user: *691 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141221,11 +141263,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *677 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + blocked_user: *691 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141304,9 +141346,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - membership: &693 + enterprise: *671 + installation: *672 + membership: &707 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -141398,8 +141440,8 @@ x-webhooks: - role - organization_url - user - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141477,11 +141519,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141560,8 +141602,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -141677,10 +141719,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 - user: *677 + user: *691 required: - action - invitation @@ -141758,11 +141800,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141849,11 +141891,11 @@ x-webhooks: properties: from: type: string - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141929,9 +141971,9 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 package: description: Information about the package. type: object @@ -142430,7 +142472,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &694 + items: &708 title: Ruby Gems metadata type: object properties: @@ -142525,7 +142567,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -142601,9 +142643,9 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 package: description: Information about the package. type: object @@ -142956,7 +142998,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *694 + items: *708 source_url: type: string format: uri @@ -143026,7 +143068,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -143203,12 +143245,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *657 + enterprise: *671 id: type: integer - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - id @@ -143285,7 +143327,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &695 + personal_access_token_request: &709 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -143431,10 +143473,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *657 - organization: *659 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143511,11 +143553,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *695 - enterprise: *657 - organization: *659 + personal_access_token_request: *709 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143591,11 +143633,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *695 - enterprise: *657 - organization: *659 + personal_access_token_request: *709 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143670,11 +143712,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *695 - organization: *659 - enterprise: *657 + personal_access_token_request: *709 + organization: *673 + enterprise: *671 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143779,7 +143821,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *696 + last_response: *710 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -143811,8 +143853,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 zen: description: Random string of GitHub zen. @@ -144057,10 +144099,10 @@ x-webhooks: - from required: - note - enterprise: *657 - installation: *658 - organization: *659 - project_card: &697 + enterprise: *671 + installation: *672 + organization: *673 + project_card: &711 title: Project Card type: object properties: @@ -144179,7 +144221,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -144260,11 +144302,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project_card: *697 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_card: *711 + repository: *674 sender: *4 required: - action @@ -144344,9 +144386,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 project_card: title: Project Card type: object @@ -144474,8 +144516,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -144569,11 +144611,11 @@ x-webhooks: - from required: - note - enterprise: *657 - installation: *658 - organization: *659 - project_card: *697 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_card: *711 + repository: *674 sender: *4 required: - action @@ -144667,9 +144709,9 @@ x-webhooks: - from required: - column_id - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 project_card: allOf: - title: Project Card @@ -144859,7 +144901,7 @@ x-webhooks: type: string required: - after_id - repository: *660 + repository: *674 sender: *4 required: - action @@ -144939,10 +144981,10 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - organization: *659 - project: &699 + enterprise: *671 + installation: *672 + organization: *673 + project: &713 title: Project type: object properties: @@ -145066,7 +145108,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -145146,10 +145188,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project_column: &698 + enterprise: *671 + installation: *672 + organization: *673 + project_column: &712 title: Project Column type: object properties: @@ -145188,7 +145230,7 @@ x-webhooks: - name - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -145267,18 +145309,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -145368,11 +145410,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 + repository: *674 sender: *4 required: - action @@ -145452,11 +145494,11 @@ x-webhooks: type: string enum: - moved - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 + repository: *674 sender: *4 required: - action @@ -145536,11 +145578,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145620,18 +145662,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - project: *699 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -145733,11 +145775,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145816,11 +145858,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145901,9 +145943,9 @@ x-webhooks: type: string enum: - closed - installation: *658 - organization: *659 - projects_v2: &700 + installation: *672 + organization: *673 + projects_v2: &714 title: Projects v2 Project description: A projects v2 project type: object @@ -146046,9 +146088,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146129,9 +146171,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146248,9 +146290,9 @@ x-webhooks: type: string to: type: string - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146333,7 +146375,7 @@ x-webhooks: type: string enum: - archived - changes: &704 + changes: &718 type: object properties: archived_at: @@ -146347,9 +146389,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *658 - organization: *659 - projects_v2_item: &701 + installation: *672 + organization: *673 + projects_v2_item: &715 title: Projects v2 Item description: An item belonging to a project type: object @@ -146483,9 +146525,9 @@ x-webhooks: nullable: true to: type: string - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146567,9 +146609,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146650,9 +146692,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146758,7 +146800,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &702 + - &716 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -146776,7 +146818,7 @@ x-webhooks: required: - id - name - - &703 + - &717 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -146799,8 +146841,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *702 - - *703 + - *716 + - *717 required: - field_value - type: object @@ -146816,9 +146858,9 @@ x-webhooks: nullable: true required: - body - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146913,9 +146955,9 @@ x-webhooks: to: type: string nullable: true - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146998,10 +147040,10 @@ x-webhooks: type: string enum: - restored - changes: *704 - installation: *658 - organization: *659 - projects_v2_item: *701 + changes: *718 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -147083,9 +147125,9 @@ x-webhooks: type: string enum: - reopened - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -147166,9 +147208,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2_status_update: &705 + installation: *672 + organization: *673 + projects_v2_status_update: &719 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -147295,9 +147337,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2_status_update: *705 + installation: *672 + organization: *673 + projects_v2_status_update: *719 sender: *4 required: - action @@ -147433,9 +147475,9 @@ x-webhooks: type: string format: date nullable: true - installation: *658 - organization: *659 - projects_v2_status_update: *705 + installation: *672 + organization: *673 + projects_v2_status_update: *719 sender: *4 required: - action @@ -147506,10 +147548,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - repository @@ -147586,13 +147628,13 @@ x-webhooks: type: string enum: - assigned - assignee: *677 - enterprise: *657 - installation: *658 - number: &706 + assignee: *691 + enterprise: *671 + installation: *672 + number: &720 description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -149875,7 +149917,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -149957,11 +149999,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -152239,7 +152281,7 @@ x-webhooks: - draft reason: type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -152321,11 +152363,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -154603,7 +154645,7 @@ x-webhooks: - draft reason: type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -154685,11 +154727,11 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: &707 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: &721 allOf: - *524 - type: object @@ -154753,7 +154795,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *660 + repository: *674 sender: *4 required: - action @@ -154834,12 +154876,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -154919,11 +154961,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *657 + enterprise: *671 milestone: *507 - number: *706 - organization: *659 - pull_request: &708 + number: *720 + organization: *673 + pull_request: &722 title: Pull Request type: object properties: @@ -157186,7 +157228,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -157265,11 +157307,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -159551,7 +159593,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *660 + repository: *674 sender: *4 required: - action @@ -159675,12 +159717,12 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -159760,11 +159802,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -162031,7 +162073,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -162111,11 +162153,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *657 - installation: *658 - label: *676 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + label: *690 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -164397,7 +164439,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -164478,10 +164520,10 @@ x-webhooks: type: string enum: - locked - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -166761,7 +166803,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -166841,12 +166883,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *657 + enterprise: *671 milestone: *507 - number: *706 - organization: *659 - pull_request: *708 - repository: *660 + number: *720 + organization: *673 + pull_request: *722 + repository: *674 sender: *4 required: - action @@ -166925,12 +166967,12 @@ x-webhooks: type: string enum: - opened - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167011,12 +167053,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167096,12 +167138,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167467,9 +167509,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -169639,7 +169681,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -169719,7 +169761,7 @@ x-webhooks: type: string enum: - deleted - comment: &710 + comment: &724 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -170004,9 +170046,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -172164,7 +172206,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -172244,11 +172286,11 @@ x-webhooks: type: string enum: - edited - changes: *709 - comment: *710 - enterprise: *657 - installation: *658 - organization: *659 + changes: *723 + comment: *724 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -174409,7 +174451,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -174490,9 +174532,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -176665,7 +176707,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 review: description: The review that was affected. type: object @@ -176908,9 +176950,9 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -178964,8 +179006,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 - review: &711 + repository: *674 + review: &725 description: The review that was affected. type: object properties: @@ -179194,12 +179236,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -181482,7 +181524,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_reviewer: title: User type: object @@ -181566,12 +181608,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -183861,7 +183903,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_team: title: Team description: Groups of organization members that gives permissions @@ -184053,12 +184095,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -186343,7 +186385,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_reviewer: title: User type: object @@ -186428,12 +186470,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -188709,7 +188751,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188890,9 +188932,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -191067,8 +191109,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 - review: *711 + repository: *674 + review: *725 sender: *4 required: - action @@ -191148,9 +191190,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -193220,7 +193262,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 sender: *4 thread: type: object @@ -193603,9 +193645,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -195661,7 +195703,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 sender: *4 thread: type: object @@ -196047,10 +196089,10 @@ x-webhooks: type: string before: type: string - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -198321,7 +198363,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -198403,11 +198445,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *712 - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + assignee: *726 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -200690,7 +200732,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -200769,11 +200811,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *657 - installation: *658 - label: *676 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + label: *690 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -203046,7 +203088,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -203127,10 +203169,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -205395,7 +205437,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -205595,7 +205637,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *657 + enterprise: *671 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -205687,8 +205729,8 @@ x-webhooks: - url - author - committer - installation: *658 - organization: *659 + installation: *672 + organization: *673 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -206263,9 +206305,9 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 registry_package: type: object properties: @@ -206711,7 +206753,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *694 + items: *708 summary: type: string tag_name: @@ -206765,7 +206807,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -206843,9 +206885,9 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 registry_package: type: object properties: @@ -207153,7 +207195,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *694 + items: *708 summary: type: string tag_name: @@ -207202,7 +207244,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -207279,10 +207321,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - release: &713 + enterprise: *671 + installation: *672 + organization: *673 + release: &727 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -207591,7 +207633,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *660 + repository: *674 sender: *4 required: - action @@ -207668,11 +207710,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -207789,11 +207831,11 @@ x-webhooks: type: boolean required: - to - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -207871,9 +207913,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -208186,7 +208228,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *660 + repository: *674 sender: *4 required: - action @@ -208262,10 +208304,10 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - release: &714 + enterprise: *671 + installation: *672 + organization: *673 + release: &728 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208575,7 +208617,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *660 + repository: *674 sender: *4 required: - action @@ -208651,11 +208693,11 @@ x-webhooks: type: string enum: - released - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -208731,11 +208773,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *657 - installation: *658 - organization: *659 - release: *714 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *728 + repository: *674 sender: *4 required: - action @@ -208811,11 +208853,11 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - repository_advisory: *584 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + repository_advisory: *598 sender: *4 required: - action @@ -208891,11 +208933,11 @@ x-webhooks: type: string enum: - reported - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - repository_advisory: *584 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + repository_advisory: *598 sender: *4 required: - action @@ -208971,10 +209013,10 @@ x-webhooks: type: string enum: - archived - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209051,10 +209093,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209132,10 +209174,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209219,10 +209261,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209334,10 +209376,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209409,10 +209451,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 status: type: string @@ -209493,10 +209535,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209573,10 +209615,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209670,10 +209712,10 @@ x-webhooks: - name required: - repository - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209753,10 +209795,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 sender: *4 required: @@ -209835,10 +209877,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 sender: *4 required: @@ -209917,10 +209959,10 @@ x-webhooks: type: string enum: - edited - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 changes: type: object @@ -210225,10 +210267,10 @@ x-webhooks: - from required: - owner - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210306,10 +210348,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210387,7 +210429,7 @@ x-webhooks: type: string enum: - create - alert: &715 + alert: &729 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -210508,10 +210550,10 @@ x-webhooks: type: string enum: - open - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210717,10 +210759,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210798,11 +210840,11 @@ x-webhooks: type: string enum: - reopen - alert: *715 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *729 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211001,10 +211043,10 @@ x-webhooks: enum: - fixed - open - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211082,7 +211124,7 @@ x-webhooks: type: string enum: - created - alert: &716 + alert: &730 type: object properties: number: *54 @@ -211193,10 +211235,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211277,11 +211319,11 @@ x-webhooks: type: string enum: - created - alert: *716 - installation: *658 - location: *717 - organization: *659 - repository: *660 + alert: *730 + installation: *672 + location: *731 + organization: *673 + repository: *674 sender: *4 required: - location @@ -211519,11 +211561,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211601,11 +211643,11 @@ x-webhooks: type: string enum: - reopened - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211683,11 +211725,11 @@ x-webhooks: type: string enum: - resolved - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211765,11 +211807,11 @@ x-webhooks: type: string enum: - validated - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211895,10 +211937,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *660 - enterprise: *657 - installation: *658 - organization: *659 + repository: *674 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -211976,11 +212018,11 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - security_advisory: &718 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + security_advisory: &732 description: The details of the security advisory, including summary, description, and severity. type: object @@ -212163,11 +212205,11 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - security_advisory: *718 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + security_advisory: *732 sender: *4 required: - action @@ -212240,10 +212282,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -212428,9 +212470,9 @@ x-webhooks: type: object properties: security_and_analysis: *238 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: *292 sender: *4 required: @@ -212509,12 +212551,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: &719 + sponsorship: &733 type: object properties: created_at: @@ -212815,12 +212857,12 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - sponsorship @@ -212908,12 +212950,12 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -212990,17 +213032,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &720 + effective_date: &734 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - sponsorship @@ -213074,7 +213116,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &721 + changes: &735 type: object properties: tier: @@ -213118,13 +213160,13 @@ x-webhooks: - from required: - tier - effective_date: *720 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + effective_date: *734 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -213201,13 +213243,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *721 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + changes: *735 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -213281,10 +213323,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213367,10 +213409,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213790,15 +213832,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *657 + enterprise: *671 id: description: The unique identifier of the status. type: integer - installation: *658 + installation: *672 name: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 sha: description: The Commit SHA. @@ -213913,9 +213955,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214005,9 +214047,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214097,9 +214139,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214189,9 +214231,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214268,12 +214310,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - team: &722 + team: &736 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -214463,9 +214505,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -214923,7 +214965,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -214999,9 +215041,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -215459,7 +215501,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -215536,9 +215578,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -215996,7 +216038,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -216140,9 +216182,9 @@ x-webhooks: - from required: - permissions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -216600,7 +216642,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - changes @@ -216678,9 +216720,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -217138,7 +217180,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -217214,10 +217256,10 @@ x-webhooks: type: string enum: - started - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -217290,16 +217332,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *657 + enterprise: *671 inputs: type: object nullable: true additionalProperties: true - installation: *658 - organization: *659 + installation: *672 + organization: *673 ref: type: string - repository: *660 + repository: *674 sender: *4 workflow: type: string @@ -217381,10 +217423,10 @@ x-webhooks: type: string enum: - completed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: allOf: @@ -217700,10 +217742,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: allOf: @@ -218042,10 +218084,10 @@ x-webhooks: type: string enum: - queued - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: type: object @@ -218259,10 +218301,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: type: object @@ -218478,12 +218520,12 @@ x-webhooks: type: string enum: - completed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object @@ -219482,12 +219524,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object @@ -220471,12 +220513,12 @@ x-webhooks: type: string enum: - requested - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 8673583a3c..d32efd861e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -23044,6 +23044,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -137592,6 +137877,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -420417,6 +420987,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -421133,6 +421988,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, @@ -421802,6 +422942,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index fe1ca41cc1..efac9c7748 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1017,7 +1017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &586 + - &600 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -9518,6 +9518,275 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &580 + - &582 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &583 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &584 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &585 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &586 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &587 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &588 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &589 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &590 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &591 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &592 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &593 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &594 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true examples: default: &257 value: @@ -10829,7 +11098,7 @@ paths: url: type: string format: uri - user: &609 + user: &623 title: Public User description: Public User type: object @@ -15317,7 +15586,7 @@ paths: - avatar_url - description examples: - default: &627 + default: &641 value: - login: github id: 1 @@ -15582,7 +15851,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *94 - - &650 + - &664 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -15591,7 +15860,7 @@ paths: required: false schema: type: integer - - &651 + - &665 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -15600,7 +15869,7 @@ paths: required: false schema: type: integer - - &652 + - &666 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is @@ -15609,7 +15878,7 @@ paths: required: false schema: type: integer - - &653 + - &667 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or @@ -17403,7 +17672,7 @@ paths: type: array items: *60 examples: - default: &621 + default: &635 value: total_count: 1 repositories: @@ -18271,7 +18540,7 @@ paths: type: array items: *120 examples: - default: &612 + default: &626 value: total_count: 1 repositories: @@ -29735,7 +30004,7 @@ paths: parameters: - *94 - *207 - - &626 + - &640 name: repo_name description: repo_name parameter in: path @@ -30763,7 +31032,7 @@ paths: - nuget - container - *94 - - &628 + - &642 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -30804,7 +31073,7 @@ paths: default: *215 '403': *29 '401': *25 - '400': &630 + '400': &644 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -36449,7 +36718,7 @@ paths: application/json: schema: type: array - items: &584 + items: &598 description: A repository security advisory. type: object properties: @@ -36740,7 +37009,7 @@ paths: - private_fork additionalProperties: false examples: - default: &585 + default: &599 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -37214,7 +37483,7 @@ paths: description: Response content: application/json: - schema: &644 + schema: &658 type: object properties: total_minutes_used: @@ -37284,7 +37553,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &645 + default: &659 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -37320,7 +37589,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &660 type: object properties: total_gigabytes_bandwidth_used: @@ -37338,7 +37607,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &647 + default: &661 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -37370,7 +37639,7 @@ paths: description: Response content: application/json: - schema: &648 + schema: &662 type: object properties: days_left_in_billing_cycle: @@ -37388,7 +37657,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &649 + default: &663 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -38599,7 +38868,7 @@ paths: - updated_at - url examples: - default: &599 + default: &613 value: - author: login: octocat @@ -38847,7 +39116,7 @@ paths: application/json: schema: *268 examples: - default: &600 + default: &614 value: author: login: octocat @@ -39030,7 +39299,7 @@ paths: - updated_at - url examples: - default: &601 + default: &615 value: - author: login: octocat @@ -39256,7 +39525,7 @@ paths: application/json: schema: *271 examples: - default: &602 + default: &616 value: author: login: octocat @@ -39872,7 +40141,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &603 + response-if-user-is-a-team-maintainer: &617 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -39937,7 +40206,7 @@ paths: application/json: schema: *278 examples: - response-if-users-membership-with-team-is-now-pending: &604 + response-if-users-membership-with-team-is-now-pending: &618 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40078,7 +40347,7 @@ paths: - updated_at - permissions examples: - default: &605 + default: &619 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40157,7 +40426,7 @@ paths: application/json: schema: *279 examples: - default: &606 + default: &620 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40367,7 +40636,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &607 + schema: &621 title: Team Repository description: A team's access to a repository. type: object @@ -41024,7 +41293,7 @@ paths: type: array items: *152 examples: - response-if-child-teams-exist: &608 + response-if-child-teams-exist: &622 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -52853,7 +53122,7 @@ paths: check. type: array items: *360 - deployment: &662 + deployment: &676 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -53765,7 +54034,7 @@ paths: type: string format: date-time nullable: true - head_commit: &688 + head_commit: &702 title: Simple Commit description: A commit. type: object @@ -57985,14 +58254,14 @@ paths: type: integer machines: type: array - items: &615 + items: &629 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *402 required: *403 examples: - default: &616 + default: &630 value: total_count: 2 machines: @@ -61292,7 +61561,7 @@ paths: application/json: schema: type: array - items: &589 + items: &603 title: Status description: The status of a commit. type: object @@ -62848,7 +63117,7 @@ paths: items: type: object properties: - placeholder_id: &581 + placeholder_id: &595 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68601,7 +68870,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &696 + last_response: &710 title: Hook Response type: object properties: @@ -69561,7 +69830,7 @@ paths: parameters: - *281 - *282 - - &639 + - &653 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -69995,7 +70264,7 @@ paths: type: array items: *477 examples: - default: &632 + default: &646 value: - id: 1 repository: @@ -83675,7 +83944,7 @@ paths: application/json: schema: type: array - items: &580 + items: &581 type: object properties: number: *54 @@ -83785,6 +84054,14 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *580 + nullable: true examples: default: value: @@ -83922,7 +84199,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -84003,7 +84280,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *581 examples: default: value: @@ -84091,7 +84368,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &717 + items: &731 type: object properties: type: @@ -84117,254 +84394,19 @@ paths: example: commit details: oneOf: - - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url + - *582 + - *583 + - *584 + - *585 + - *586 + - *587 + - *588 + - *589 + - *590 + - *591 + - *592 + - *593 + - *594 examples: default: value: @@ -84459,14 +84501,14 @@ paths: schema: type: object properties: - reason: &582 + reason: &596 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *581 + placeholder_id: *595 required: - reason - placeholder_id @@ -84483,7 +84525,7 @@ paths: schema: type: object properties: - reason: *582 + reason: *596 expire_at: type: string format: date-time @@ -84542,7 +84584,7 @@ paths: properties: incremental_scans: type: array - items: &583 + items: &597 description: Information on a single scan performed by secret scanning on the repository type: object @@ -84568,15 +84610,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *583 + items: *597 backfill_scans: type: array - items: *583 + items: *597 custom_pattern_backfill_scans: type: array items: allOf: - - *583 + - *597 - type: object properties: pattern_name: @@ -84691,9 +84733,9 @@ paths: application/json: schema: type: array - items: *584 + items: *598 examples: - default: *585 + default: *599 '400': *14 '404': *6 x-github: @@ -84877,9 +84919,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: &587 + default: &601 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -85217,7 +85259,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: default: value: @@ -85366,15 +85408,15 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '200': description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: *587 + default: *601 '403': *29 '404': *6 x-github: @@ -85400,7 +85442,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 requestBody: required: true content: @@ -85559,10 +85601,10 @@ paths: description: Response content: application/json: - schema: *584 + schema: *598 examples: - default: *587 - add_credit: *587 + default: *601 + add_credit: *601 '403': *29 '404': *6 '422': @@ -85602,7 +85644,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '202': *39 '400': *14 @@ -85631,7 +85673,7 @@ paths: parameters: - *281 - *282 - - *586 + - *600 responses: '202': description: Response @@ -85775,7 +85817,7 @@ paths: application/json: schema: type: array - items: &588 + items: &602 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -86148,7 +86190,7 @@ paths: application/json: schema: type: array - items: *588 + items: *602 examples: default: value: @@ -86236,7 +86278,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *603 examples: default: value: @@ -86330,7 +86372,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &590 + schema: &604 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -86425,7 +86467,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *604 examples: default: value: @@ -86562,7 +86604,7 @@ paths: application/json: schema: type: array - items: &591 + items: &605 title: Tag protection description: Tag protection type: object @@ -86638,7 +86680,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *605 examples: default: value: @@ -86786,7 +86828,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &606 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -86798,7 +86840,7 @@ paths: required: - names examples: - default: &593 + default: &607 value: names: - octocat @@ -86853,9 +86895,9 @@ paths: description: Response content: application/json: - schema: *592 + schema: *606 examples: - default: *593 + default: *607 '404': *6 '422': *7 x-github: @@ -86878,7 +86920,7 @@ paths: parameters: - *281 - *282 - - &594 + - &608 name: per description: The time frame to display results for. in: query @@ -86907,7 +86949,7 @@ paths: example: 128 clones: type: array - items: &595 + items: &609 title: Traffic type: object properties: @@ -87148,7 +87190,7 @@ paths: parameters: - *281 - *282 - - *594 + - *608 responses: '200': description: Response @@ -87167,7 +87209,7 @@ paths: example: 3782 views: type: array - items: *595 + items: *609 required: - uniques - count @@ -87936,7 +87978,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &596 + text_matches: &610 title: Search Result Text Matches type: array items: @@ -88098,7 +88140,7 @@ paths: enum: - author-date - committer-date - - &597 + - &611 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -88226,7 +88268,7 @@ paths: type: number node_id: type: string - text_matches: *596 + text_matches: *610 required: - sha - node_id @@ -88408,7 +88450,7 @@ paths: - interactions - created - updated - - *597 + - *611 - *17 - *19 - name: advanced_search @@ -88550,7 +88592,7 @@ paths: type: string format: date-time nullable: true - text_matches: *596 + text_matches: *610 pull_request: type: object properties: @@ -88778,7 +88820,7 @@ paths: enum: - created - updated - - *597 + - *611 - *17 - *19 responses: @@ -88822,7 +88864,7 @@ paths: nullable: true score: type: number - text_matches: *596 + text_matches: *610 required: - id - node_id @@ -88907,7 +88949,7 @@ paths: - forks - help-wanted-issues - updated - - *597 + - *611 - *17 - *19 responses: @@ -89146,7 +89188,7 @@ paths: - admin - pull - push - text_matches: *596 + text_matches: *610 temp_clone_token: type: string allow_merge_commit: @@ -89446,7 +89488,7 @@ paths: type: string format: uri nullable: true - text_matches: *596 + text_matches: *610 related: type: array nullable: true @@ -89637,7 +89679,7 @@ paths: - followers - repositories - joined - - *597 + - *611 - *17 - *19 responses: @@ -89741,7 +89783,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *596 + text_matches: *610 blog: type: string nullable: true @@ -89820,7 +89862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &598 + - &612 name: team_id description: The unique identifier of the team. in: path @@ -89861,7 +89903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *598 + - *612 requestBody: required: true content: @@ -89961,7 +90003,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *598 + - *612 responses: '204': description: Response @@ -89992,7 +90034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *598 + - *612 - *48 - *17 - *19 @@ -90005,7 +90047,7 @@ paths: type: array items: *268 examples: - default: *599 + default: *613 headers: Link: *58 x-github: @@ -90034,7 +90076,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *598 + - *612 requestBody: required: true content: @@ -90097,7 +90139,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *598 + - *612 - *270 responses: '200': @@ -90131,7 +90173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *598 + - *612 - *270 requestBody: required: false @@ -90157,7 +90199,7 @@ paths: application/json: schema: *268 examples: - default: *600 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90182,7 +90224,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *598 + - *612 - *270 responses: '204': @@ -90212,7 +90254,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *598 + - *612 - *270 - *48 - *17 @@ -90226,7 +90268,7 @@ paths: type: array items: *271 examples: - default: *601 + default: *615 headers: Link: *58 x-github: @@ -90255,7 +90297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 requestBody: required: true @@ -90307,7 +90349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 responses: @@ -90342,7 +90384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 requestBody: @@ -90368,7 +90410,7 @@ paths: application/json: schema: *271 examples: - default: *602 + default: *616 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90393,7 +90435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 responses: @@ -90424,7 +90466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 - name: content @@ -90483,7 +90525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *598 + - *612 - *270 - *273 requestBody: @@ -90545,7 +90587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *598 + - *612 - *270 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -90603,7 +90645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *598 + - *612 - *270 requestBody: required: true @@ -90662,7 +90704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -90700,7 +90742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *598 + - *612 - name: role description: Filters members returned by their role in the team. in: query @@ -90751,7 +90793,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90788,7 +90830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90828,7 +90870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90865,7 +90907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 responses: '200': @@ -90874,7 +90916,7 @@ paths: application/json: schema: *278 examples: - response-if-user-is-a-team-maintainer: *603 + response-if-user-is-a-team-maintainer: *617 '404': *6 x-github: githubCloudOnly: false @@ -90907,7 +90949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 requestBody: required: false @@ -90935,7 +90977,7 @@ paths: application/json: schema: *278 examples: - response-if-users-membership-with-team-is-now-pending: *604 + response-if-users-membership-with-team-is-now-pending: *618 '403': description: Forbidden if team synchronization is set up '422': @@ -90969,7 +91011,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *598 + - *612 - *133 responses: '204': @@ -90998,7 +91040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91010,7 +91052,7 @@ paths: type: array items: *279 examples: - default: *605 + default: *619 headers: Link: *58 '404': *6 @@ -91036,7 +91078,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *598 + - *612 - *280 responses: '200': @@ -91045,7 +91087,7 @@ paths: application/json: schema: *279 examples: - default: *606 + default: *620 '404': description: Not Found if project is not managed by this team x-github: @@ -91069,7 +91111,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *598 + - *612 - *280 requestBody: required: false @@ -91137,7 +91179,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *598 + - *612 - *280 responses: '204': @@ -91165,7 +91207,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91207,7 +91249,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *598 + - *612 - *281 - *282 responses: @@ -91215,7 +91257,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *607 + schema: *621 examples: alternative-response-with-extra-repository-information: value: @@ -91366,7 +91408,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *598 + - *612 - *281 - *282 requestBody: @@ -91418,7 +91460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *598 + - *612 - *281 - *282 responses: @@ -91445,7 +91487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *598 + - *612 - *17 - *19 responses: @@ -91457,7 +91499,7 @@ paths: type: array items: *152 examples: - response-if-child-teams-exist: *608 + response-if-child-teams-exist: *622 headers: Link: *58 '404': *6 @@ -91490,7 +91532,7 @@ paths: application/json: schema: oneOf: - - &610 + - &624 title: Private User description: Private User type: object @@ -91693,7 +91735,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *609 + - *623 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -91846,7 +91888,7 @@ paths: description: Response content: application/json: - schema: *610 + schema: *624 examples: default: value: @@ -92244,7 +92286,7 @@ paths: type: integer secrets: type: array - items: &611 + items: &625 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -92360,7 +92402,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *625 examples: default: value: @@ -92506,7 +92548,7 @@ paths: type: array items: *120 examples: - default: *612 + default: *626 '401': *25 '403': *29 '404': *6 @@ -92773,7 +92815,7 @@ paths: description: Response content: application/json: - schema: &613 + schema: &627 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -92814,7 +92856,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &614 + default: &628 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -92859,9 +92901,9 @@ paths: description: Response content: application/json: - schema: *613 + schema: *627 examples: - default: *614 + default: *628 '404': *6 x-github: githubCloudOnly: false @@ -92898,9 +92940,9 @@ paths: type: integer machines: type: array - items: *615 + items: *629 examples: - default: *616 + default: *630 '304': *37 '500': *95 '401': *25 @@ -93839,7 +93881,7 @@ paths: type: array items: *214 examples: - default: &629 + default: &643 value: - id: 197 name: hello_docker @@ -93940,7 +93982,7 @@ paths: application/json: schema: type: array - items: &617 + items: &631 title: Email description: Email type: object @@ -94005,9 +94047,9 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: - default: &631 + default: &645 value: - email: octocat@github.com verified: true @@ -94082,7 +94124,7 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: default: value: @@ -94338,7 +94380,7 @@ paths: application/json: schema: type: array - items: &618 + items: &632 title: GPG Key description: A unique encryption key type: object @@ -94469,7 +94511,7 @@ paths: - subkeys - revoked examples: - default: &642 + default: &656 value: - id: 3 name: Octocat's GPG Key @@ -94554,9 +94596,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *632 examples: - default: &619 + default: &633 value: id: 3 name: Octocat's GPG Key @@ -94613,7 +94655,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &620 + - &634 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -94625,9 +94667,9 @@ paths: description: Response content: application/json: - schema: *618 + schema: *632 examples: - default: *619 + default: *633 '404': *6 '304': *37 '403': *29 @@ -94650,7 +94692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *620 + - *634 responses: '204': description: Response @@ -94841,7 +94883,7 @@ paths: type: array items: *60 examples: - default: *621 + default: *635 headers: Link: *58 '404': *6 @@ -95105,7 +95147,7 @@ paths: application/json: schema: type: array - items: &622 + items: &636 title: Key description: Key type: object @@ -95202,9 +95244,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *636 examples: - default: &623 + default: &637 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -95243,9 +95285,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *636 examples: - default: *623 + default: *637 '404': *6 '304': *37 '403': *29 @@ -95301,7 +95343,7 @@ paths: application/json: schema: type: array - items: &624 + items: &638 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -95369,7 +95411,7 @@ paths: - account - plan examples: - default: &625 + default: &639 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -95431,9 +95473,9 @@ paths: application/json: schema: type: array - items: *624 + items: *638 examples: - default: *625 + default: *639 headers: Link: *58 '304': *37 @@ -96428,7 +96470,7 @@ paths: url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - *207 - - *626 + - *640 responses: '204': description: Response @@ -96501,7 +96543,7 @@ paths: type: array items: *203 examples: - default: *627 + default: *641 headers: Link: *58 '304': *37 @@ -96543,7 +96585,7 @@ paths: - docker - nuget - container - - *628 + - *642 - *19 - *17 responses: @@ -96555,8 +96597,8 @@ paths: type: array items: *214 examples: - default: *629 - '400': *630 + default: *643 + '400': *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96585,7 +96627,7 @@ paths: application/json: schema: *214 examples: - default: &643 + default: &657 value: id: 40201 name: octo-name @@ -97038,9 +97080,9 @@ paths: application/json: schema: type: array - items: *617 + items: *631 examples: - default: *631 + default: *645 headers: Link: *58 '304': *37 @@ -97153,7 +97195,7 @@ paths: type: array items: *60 examples: - default: &638 + default: &652 summary: Default response value: - id: 1296269 @@ -97499,7 +97541,7 @@ paths: type: array items: *477 examples: - default: *632 + default: *646 headers: Link: *58 '304': *37 @@ -97578,7 +97620,7 @@ paths: application/json: schema: type: array - items: &633 + items: &647 title: Social account description: Social media account type: object @@ -97593,7 +97635,7 @@ paths: - provider - url examples: - default: &634 + default: &648 value: - provider: twitter url: https://twitter.com/github @@ -97655,9 +97697,9 @@ paths: application/json: schema: type: array - items: *633 + items: *647 examples: - default: *634 + default: *648 '422': *15 '304': *37 '404': *6 @@ -97744,7 +97786,7 @@ paths: application/json: schema: type: array - items: &635 + items: &649 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -97764,7 +97806,7 @@ paths: - title - created_at examples: - default: &654 + default: &668 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -97830,9 +97872,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *649 examples: - default: &636 + default: &650 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -97863,7 +97905,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &637 + - &651 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -97875,9 +97917,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *649 examples: - default: *636 + default: *650 '404': *6 '304': *37 '403': *29 @@ -97900,7 +97942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *637 + - *651 responses: '204': description: Response @@ -97929,7 +97971,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &655 + - &669 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -97954,11 +97996,11 @@ paths: type: array items: *60 examples: - default-response: *638 + default-response: *652 application/vnd.github.v3.star+json: schema: type: array - items: &656 + items: &670 title: Starred Repository description: Starred Repository type: object @@ -98327,10 +98369,10 @@ paths: application/json: schema: oneOf: - - *610 - - *609 + - *624 + - *623 examples: - default-response: &640 + default-response: &654 summary: Default response value: login: octocat @@ -98365,7 +98407,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &641 + response-with-git-hub-plan-information: &655 summary: Response with GitHub plan information value: login: octocat @@ -98425,7 +98467,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *639 + - *653 - *17 responses: '200': @@ -98474,11 +98516,11 @@ paths: application/json: schema: oneOf: - - *610 - - *609 + - *624 + - *623 examples: - default-response: *640 - response-with-git-hub-plan-information: *641 + default-response: *654 + response-with-git-hub-plan-information: *655 '404': *6 x-github: githubCloudOnly: false @@ -98595,7 +98637,7 @@ paths: type: array items: *214 examples: - default: *629 + default: *643 '403': *29 '401': *25 x-github: @@ -98999,9 +99041,9 @@ paths: application/json: schema: type: array - items: *618 + items: *632 examples: - default: *642 + default: *656 headers: Link: *58 x-github: @@ -99183,7 +99225,7 @@ paths: type: array items: *203 examples: - default: *627 + default: *641 headers: Link: *58 x-github: @@ -99222,7 +99264,7 @@ paths: - docker - nuget - container - - *628 + - *642 - *133 - *19 - *17 @@ -99235,10 +99277,10 @@ paths: type: array items: *214 examples: - default: *629 + default: *643 '403': *29 '401': *25 - '400': *630 + '400': *644 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99268,7 +99310,7 @@ paths: application/json: schema: *214 examples: - default: *643 + default: *657 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99867,9 +99909,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *658 examples: - default: *645 + default: *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99897,9 +99939,9 @@ paths: description: Response content: application/json: - schema: *646 + schema: *660 examples: - default: *647 + default: *661 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99927,9 +99969,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *662 examples: - default: *649 + default: *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99950,10 +99992,10 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *133 - - *650 - - *651 - - *652 - - *653 + - *664 + - *665 + - *666 + - *667 responses: '200': description: Response when getting a billing usage report @@ -100052,9 +100094,9 @@ paths: application/json: schema: type: array - items: *633 + items: *647 examples: - default: *634 + default: *648 headers: Link: *58 x-github: @@ -100084,9 +100126,9 @@ paths: application/json: schema: type: array - items: *635 + items: *649 examples: - default: *654 + default: *668 headers: Link: *58 x-github: @@ -100111,7 +100153,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *133 - - *655 + - *669 - *48 - *17 - *19 @@ -100123,11 +100165,11 @@ paths: schema: anyOf: - type: array - items: *656 + items: *670 - type: array items: *60 examples: - default-response: *638 + default-response: *652 headers: Link: *58 x-github: @@ -100286,7 +100328,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &657 + enterprise: &671 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -100344,7 +100386,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &658 + installation: &672 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -100363,7 +100405,7 @@ x-webhooks: required: - id - node_id - organization: &659 + organization: &673 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -100423,13 +100465,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &660 + repository: &674 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &690 + properties: &704 id: description: Unique identifier of the repository example: 42 @@ -101112,7 +101154,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &691 + required: &705 - archive_url - assignees_url - blobs_url @@ -101263,10 +101305,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -101342,11 +101384,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: &661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: &675 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -101569,11 +101611,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: *661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: *675 sender: *4 required: - action @@ -101756,11 +101798,11 @@ x-webhooks: - everyone required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - rule: *661 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + rule: *675 sender: *4 required: - action @@ -101844,7 +101886,7 @@ x-webhooks: type: string enum: - completed - check_run: &663 + check_run: &677 title: CheckRun description: A check performed on the code of a given code change type: object @@ -101945,7 +101987,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *662 + deployment: *676 details_url: example: https://example.com type: string @@ -102030,9 +102072,9 @@ x-webhooks: - output - app - pull_requests - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -102425,10 +102467,10 @@ x-webhooks: type: string enum: - created - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -102824,10 +102866,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 requested_action: description: The action requested by the user. type: object @@ -103232,10 +103274,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *663 - installation: *658 - organization: *659 - repository: *660 + check_run: *677 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - check_run @@ -104212,10 +104254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -104885,10 +104927,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -105552,10 +105594,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -105863,20 +105905,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &664 + commit_oid: &678 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *657 - installation: *658 - organization: *659 - ref: &665 + enterprise: *671 + installation: *672 + organization: *673 + ref: &679 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -106268,12 +106310,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -106536,12 +106578,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -106870,12 +106912,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -107140,16 +107182,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *660 + repository: *674 sender: *4 required: - action @@ -107383,12 +107425,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *664 - enterprise: *657 - installation: *658 - organization: *659 - ref: *665 - repository: *660 + commit_oid: *678 + enterprise: *671 + installation: *672 + organization: *673 + ref: *679 + repository: *674 sender: *4 required: - action @@ -107645,10 +107687,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -107728,18 +107770,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *659 - pusher_type: &666 + organization: *673 + pusher_type: &680 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &667 + ref: &681 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -107749,7 +107791,7 @@ x-webhooks: enum: - tag - branch - repository: *660 + repository: *674 sender: *4 required: - ref @@ -107832,9 +107874,9 @@ x-webhooks: enum: - created definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -107919,9 +107961,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -107999,9 +108041,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -108079,9 +108121,9 @@ x-webhooks: enum: - updated definition: *231 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -108158,10 +108200,10 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - repository: *660 - organization: *659 + enterprise: *671 + installation: *672 + repository: *674 + organization: *673 sender: *4 new_property_values: type: array @@ -108246,18 +108288,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - pusher_type: *666 - ref: *667 + enterprise: *671 + installation: *672 + organization: *673 + pusher_type: *680 + ref: *681 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *660 + repository: *674 sender: *4 required: - ref @@ -108342,10 +108384,10 @@ x-webhooks: enum: - auto_dismissed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108430,10 +108472,10 @@ x-webhooks: enum: - auto_reopened alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108518,10 +108560,10 @@ x-webhooks: enum: - created alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108604,10 +108646,10 @@ x-webhooks: enum: - dismissed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108690,10 +108732,10 @@ x-webhooks: enum: - fixed alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108777,10 +108819,10 @@ x-webhooks: enum: - reintroduced alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108863,10 +108905,10 @@ x-webhooks: enum: - reopened alert: *433 - installation: *658 - organization: *659 - enterprise: *657 - repository: *660 + installation: *672 + organization: *673 + enterprise: *671 + repository: *674 sender: *4 required: - action @@ -108943,9 +108985,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - key: &668 + enterprise: *671 + installation: *672 + key: &682 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -108981,8 +109023,8 @@ x-webhooks: - verified - created_at - read_only - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -109059,11 +109101,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - key: *668 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + key: *682 + organization: *673 + repository: *674 sender: *4 required: - action @@ -109624,12 +109666,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: &672 + workflow: &686 title: Workflow type: object nullable: true @@ -110359,9 +110401,9 @@ x-webhooks: pull_requests: type: array items: *524 - repository: *660 - organization: *659 - installation: *658 + repository: *674 + organization: *673 + installation: *672 sender: *4 responses: '200': @@ -110432,7 +110474,7 @@ x-webhooks: type: string enum: - approved - approver: &669 + approver: &683 type: object properties: avatar_url: @@ -110475,11 +110517,11 @@ x-webhooks: type: string comment: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - reviewers: &670 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + reviewers: &684 type: array items: type: object @@ -110558,7 +110600,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &671 + workflow_job_run: &685 type: object properties: conclusion: @@ -111289,18 +111331,18 @@ x-webhooks: type: string enum: - rejected - approver: *669 + approver: *683 comment: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - reviewers: *670 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + reviewers: *684 sender: *4 since: type: string - workflow_job_run: *671 + workflow_job_run: *685 workflow_job_runs: type: array items: @@ -112004,13 +112046,13 @@ x-webhooks: type: string enum: - requested - enterprise: *657 + enterprise: *671 environment: type: string - installation: *658 - organization: *659 - repository: *660 - requestor: &677 + installation: *672 + organization: *673 + repository: *674 + requestor: &691 title: User type: object nullable: true @@ -113909,12 +113951,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Deployment Workflow Run type: object @@ -114594,7 +114636,7 @@ x-webhooks: type: string enum: - answered - answer: &675 + answer: &689 type: object properties: author_association: @@ -114751,7 +114793,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &673 + discussion: &687 title: Discussion description: A Discussion in a repository. type: object @@ -115059,10 +115101,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115189,11 +115231,11 @@ x-webhooks: - from required: - category - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115276,11 +115318,11 @@ x-webhooks: type: string enum: - closed - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115362,7 +115404,7 @@ x-webhooks: type: string enum: - created - comment: &674 + comment: &688 type: object properties: author_association: @@ -115519,11 +115561,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115606,12 +115648,12 @@ x-webhooks: type: string enum: - deleted - comment: *674 - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + comment: *688 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115706,12 +115748,12 @@ x-webhooks: - from required: - body - comment: *674 - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + comment: *688 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115795,11 +115837,11 @@ x-webhooks: type: string enum: - created - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115881,11 +115923,11 @@ x-webhooks: type: string enum: - deleted - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -115985,11 +116027,11 @@ x-webhooks: type: string required: - from - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116071,10 +116113,10 @@ x-webhooks: type: string enum: - labeled - discussion: *673 - enterprise: *657 - installation: *658 - label: &676 + discussion: *687 + enterprise: *671 + installation: *672 + label: &690 title: Label type: object properties: @@ -116106,8 +116148,8 @@ x-webhooks: - color - default - description - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116190,11 +116232,11 @@ x-webhooks: type: string enum: - locked - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116276,11 +116318,11 @@ x-webhooks: type: string enum: - pinned - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116362,11 +116404,11 @@ x-webhooks: type: string enum: - reopened - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116451,16 +116493,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *673 - new_repository: *660 + new_discussion: *687 + new_repository: *674 required: - new_discussion - new_repository - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116543,10 +116585,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *673 - old_answer: *675 - organization: *659 - repository: *660 + discussion: *687 + old_answer: *689 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116628,12 +116670,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *673 - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116716,11 +116758,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116802,11 +116844,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *673 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + discussion: *687 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -116879,7 +116921,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *657 + enterprise: *671 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -117539,9 +117581,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - forkee @@ -117687,9 +117729,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pages: description: The pages that were updated. type: array @@ -117726,7 +117768,7 @@ x-webhooks: - action - sha - html_url - repository: *660 + repository: *674 sender: *4 required: - pages @@ -117802,10 +117844,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: &678 + organization: *673 + repositories: &692 description: An array of repository objects that the installation can access. type: array @@ -117831,8 +117873,8 @@ x-webhooks: - name - full_name - private - repository: *660 - requester: *677 + repository: *674 + requester: *691 sender: *4 required: - action @@ -117907,11 +117949,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -117987,11 +118029,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118067,10 +118109,10 @@ x-webhooks: type: string enum: - added - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories_added: &679 + organization: *673 + repositories_added: &693 description: An array of repository objects, which were added to the installation. type: array @@ -118116,15 +118158,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *660 - repository_selection: &680 + repository: *674 + repository_selection: &694 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *677 + requester: *691 sender: *4 required: - action @@ -118203,10 +118245,10 @@ x-webhooks: type: string enum: - removed - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories_added: *679 + organization: *673 + repositories_added: *693 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -118233,9 +118275,9 @@ x-webhooks: - name - full_name - private - repository: *660 - repository_selection: *680 - requester: *677 + repository: *674 + repository_selection: *694 + requester: *691 sender: *4 required: - action @@ -118314,11 +118356,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118496,10 +118538,10 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 target_type: type: string @@ -118578,11 +118620,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *657 + enterprise: *671 installation: *22 - organization: *659 - repositories: *678 - repository: *660 + organization: *673 + repositories: *692 + repository: *674 requester: nullable: true sender: *4 @@ -118834,8 +118876,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119991,8 +120033,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -120072,7 +120114,7 @@ x-webhooks: type: string enum: - deleted - comment: &681 + comment: &695 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -120237,8 +120279,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121392,8 +121434,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -121473,7 +121515,7 @@ x-webhooks: type: string enum: - edited - changes: &709 + changes: &723 description: The changes to the comment. type: object properties: @@ -121485,9 +121527,9 @@ x-webhooks: type: string required: - from - comment: *681 - enterprise: *657 - installation: *658 + comment: *695 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -122642,8 +122684,8 @@ x-webhooks: - state - locked - assignee - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -122725,10 +122767,10 @@ x-webhooks: type: string enum: - assigned - assignee: *677 - enterprise: *657 - installation: *658 - issue: &684 + assignee: *691 + enterprise: *671 + installation: *672 + issue: &698 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -123647,8 +123689,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -123728,8 +123770,8 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -124788,8 +124830,8 @@ x-webhooks: required: - state - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -124868,8 +124910,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125783,8 +125825,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -125863,8 +125905,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126779,7 +126821,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &682 + milestone: &696 title: Milestone description: A collection of related issues and pull requests. type: object @@ -126917,8 +126959,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -127017,8 +127059,8 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127937,9 +127979,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *676 - organization: *659 - repository: *660 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -128019,8 +128061,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128938,9 +128980,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *676 - organization: *659 - repository: *660 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -129020,8 +129062,8 @@ x-webhooks: type: string enum: - locked - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129940,8 +129982,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -130020,8 +130062,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -130934,9 +130976,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *682 - organization: *659 - repository: *660 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -132379,8 +132421,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133298,8 +133340,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -133379,9 +133421,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *657 - installation: *658 - issue: &683 + enterprise: *671 + installation: *672 + issue: &697 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -134293,8 +134335,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -134373,8 +134415,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135292,8 +135334,8 @@ x-webhooks: user_view_type: type: string type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136756,11 +136798,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *657 - installation: *658 - issue: *683 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *697 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136840,12 +136882,12 @@ x-webhooks: type: string enum: - typed - enterprise: *657 - installation: *658 - issue: *684 + enterprise: *671 + installation: *672 + issue: *698 type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -136926,7 +136968,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &712 + assignee: &726 title: User type: object nullable: true @@ -136996,11 +137038,11 @@ x-webhooks: required: - login - id - enterprise: *657 - installation: *658 - issue: *684 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *698 + organization: *673 + repository: *674 sender: *4 required: - action @@ -137079,12 +137121,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *657 - installation: *658 - issue: *684 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *698 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -137164,8 +137206,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138082,8 +138124,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138163,11 +138205,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *657 - installation: *658 - issue: *683 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + issue: *697 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138246,12 +138288,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *657 - installation: *658 - issue: *684 + enterprise: *671 + installation: *672 + issue: *698 type: *193 - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138331,11 +138373,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138413,11 +138455,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138527,11 +138569,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - label: *676 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + label: *690 + organization: *673 + repository: *674 sender: *4 required: - action @@ -138613,9 +138655,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: &685 + enterprise: *671 + installation: *672 + marketplace_purchase: &699 title: Marketplace Purchase type: object required: @@ -138698,8 +138740,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *659 - previous_marketplace_purchase: &686 + organization: *673 + previous_marketplace_purchase: &700 title: Marketplace Purchase type: object properties: @@ -138779,7 +138821,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -138859,10 +138901,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -138945,7 +138987,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -139027,10 +139069,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -139112,7 +139154,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *660 + repository: *674 sender: *4 required: - action @@ -139193,8 +139235,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 marketplace_purchase: title: Marketplace Purchase type: object @@ -139276,9 +139318,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *659 - previous_marketplace_purchase: *686 - repository: *660 + organization: *673 + previous_marketplace_purchase: *700 + repository: *674 sender: *4 required: - action @@ -139358,12 +139400,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *657 - installation: *658 - marketplace_purchase: *685 - organization: *659 - previous_marketplace_purchase: *686 - repository: *660 + enterprise: *671 + installation: *672 + marketplace_purchase: *699 + organization: *673 + previous_marketplace_purchase: *700 + repository: *674 sender: *4 required: - action @@ -139465,11 +139507,11 @@ x-webhooks: type: string required: - to - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139569,11 +139611,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139652,11 +139694,11 @@ x-webhooks: type: string enum: - removed - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 sender: *4 required: - action @@ -139734,11 +139776,11 @@ x-webhooks: type: string enum: - added - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 scope: description: The scope of the membership. Currently, can only be `team`. @@ -139814,7 +139856,7 @@ x-webhooks: required: - login - id - team: &687 + team: &701 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -140004,11 +140046,11 @@ x-webhooks: type: string enum: - removed - enterprise: *657 - installation: *658 - member: *677 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + member: *691 + organization: *673 + repository: *674 scope: description: The scope of the membership. Currently, can only be `team`. @@ -140085,7 +140127,7 @@ x-webhooks: required: - login - id - team: *687 + team: *701 required: - action - scope @@ -140167,8 +140209,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *658 - merge_group: &689 + installation: *672 + merge_group: &703 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -140187,15 +140229,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *688 + head_commit: *702 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140281,10 +140323,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *658 - merge_group: *689 - organization: *659 - repository: *660 + installation: *672 + merge_group: *703 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140357,7 +140399,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 + enterprise: *671 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -140465,16 +140507,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *658 - organization: *659 + installation: *672 + organization: *673 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -140555,11 +140597,11 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140638,9 +140680,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - milestone: &692 + enterprise: *671 + installation: *672 + milestone: &706 title: Milestone description: A collection of related issues and pull requests. type: object @@ -140777,8 +140819,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140857,11 +140899,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -140971,11 +141013,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - milestone: *682 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *696 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141055,11 +141097,11 @@ x-webhooks: type: string enum: - opened - enterprise: *657 - installation: *658 - milestone: *692 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + milestone: *706 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141138,11 +141180,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *677 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + blocked_user: *691 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141221,11 +141263,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *677 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + blocked_user: *691 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141304,9 +141346,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - membership: &693 + enterprise: *671 + installation: *672 + membership: &707 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -141398,8 +141440,8 @@ x-webhooks: - role - organization_url - user - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141477,11 +141519,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141560,8 +141602,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -141677,10 +141719,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 - user: *677 + user: *691 required: - action - invitation @@ -141758,11 +141800,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141849,11 +141891,11 @@ x-webhooks: properties: from: type: string - enterprise: *657 - installation: *658 - membership: *693 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + membership: *707 + organization: *673 + repository: *674 sender: *4 required: - action @@ -141929,9 +141971,9 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 package: description: Information about the package. type: object @@ -142430,7 +142472,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &694 + items: &708 title: Ruby Gems metadata type: object properties: @@ -142525,7 +142567,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -142601,9 +142643,9 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 package: description: Information about the package. type: object @@ -142956,7 +142998,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *694 + items: *708 source_url: type: string format: uri @@ -143026,7 +143068,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -143203,12 +143245,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *657 + enterprise: *671 id: type: integer - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - id @@ -143285,7 +143327,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &695 + personal_access_token_request: &709 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -143431,10 +143473,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *657 - organization: *659 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143511,11 +143553,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *695 - enterprise: *657 - organization: *659 + personal_access_token_request: *709 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143591,11 +143633,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *695 - enterprise: *657 - organization: *659 + personal_access_token_request: *709 + enterprise: *671 + organization: *673 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143670,11 +143712,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *695 - organization: *659 - enterprise: *657 + personal_access_token_request: *709 + organization: *673 + enterprise: *671 sender: *4 - installation: *658 + installation: *672 required: - action - personal_access_token_request @@ -143779,7 +143821,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *696 + last_response: *710 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -143811,8 +143853,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 zen: description: Random string of GitHub zen. @@ -144057,10 +144099,10 @@ x-webhooks: - from required: - note - enterprise: *657 - installation: *658 - organization: *659 - project_card: &697 + enterprise: *671 + installation: *672 + organization: *673 + project_card: &711 title: Project Card type: object properties: @@ -144179,7 +144221,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -144260,11 +144302,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project_card: *697 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_card: *711 + repository: *674 sender: *4 required: - action @@ -144344,9 +144386,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 project_card: title: Project Card type: object @@ -144474,8 +144516,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -144569,11 +144611,11 @@ x-webhooks: - from required: - note - enterprise: *657 - installation: *658 - organization: *659 - project_card: *697 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_card: *711 + repository: *674 sender: *4 required: - action @@ -144667,9 +144709,9 @@ x-webhooks: - from required: - column_id - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 project_card: allOf: - title: Project Card @@ -144859,7 +144901,7 @@ x-webhooks: type: string required: - after_id - repository: *660 + repository: *674 sender: *4 required: - action @@ -144939,10 +144981,10 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - organization: *659 - project: &699 + enterprise: *671 + installation: *672 + organization: *673 + project: &713 title: Project type: object properties: @@ -145066,7 +145108,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -145146,10 +145188,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project_column: &698 + enterprise: *671 + installation: *672 + organization: *673 + project_column: &712 title: Project Column type: object properties: @@ -145188,7 +145230,7 @@ x-webhooks: - name - created_at - updated_at - repository: *660 + repository: *674 sender: *4 required: - action @@ -145267,18 +145309,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -145368,11 +145410,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 + repository: *674 sender: *4 required: - action @@ -145452,11 +145494,11 @@ x-webhooks: type: string enum: - moved - enterprise: *657 - installation: *658 - organization: *659 - project_column: *698 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project_column: *712 + repository: *674 sender: *4 required: - action @@ -145536,11 +145578,11 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145620,18 +145662,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - project: *699 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *690 - required: *691 + properties: *704 + required: *705 nullable: true sender: *4 required: @@ -145733,11 +145775,11 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145816,11 +145858,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 - organization: *659 - project: *699 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + project: *713 + repository: *674 sender: *4 required: - action @@ -145901,9 +145943,9 @@ x-webhooks: type: string enum: - closed - installation: *658 - organization: *659 - projects_v2: &700 + installation: *672 + organization: *673 + projects_v2: &714 title: Projects v2 Project description: A projects v2 project type: object @@ -146046,9 +146088,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146129,9 +146171,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146248,9 +146290,9 @@ x-webhooks: type: string to: type: string - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -146333,7 +146375,7 @@ x-webhooks: type: string enum: - archived - changes: &704 + changes: &718 type: object properties: archived_at: @@ -146347,9 +146389,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *658 - organization: *659 - projects_v2_item: &701 + installation: *672 + organization: *673 + projects_v2_item: &715 title: Projects v2 Item description: An item belonging to a project type: object @@ -146483,9 +146525,9 @@ x-webhooks: nullable: true to: type: string - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146567,9 +146609,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146650,9 +146692,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146758,7 +146800,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &702 + - &716 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -146776,7 +146818,7 @@ x-webhooks: required: - id - name - - &703 + - &717 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -146799,8 +146841,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *702 - - *703 + - *716 + - *717 required: - field_value - type: object @@ -146816,9 +146858,9 @@ x-webhooks: nullable: true required: - body - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146913,9 +146955,9 @@ x-webhooks: to: type: string nullable: true - installation: *658 - organization: *659 - projects_v2_item: *701 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -146998,10 +147040,10 @@ x-webhooks: type: string enum: - restored - changes: *704 - installation: *658 - organization: *659 - projects_v2_item: *701 + changes: *718 + installation: *672 + organization: *673 + projects_v2_item: *715 sender: *4 required: - action @@ -147083,9 +147125,9 @@ x-webhooks: type: string enum: - reopened - installation: *658 - organization: *659 - projects_v2: *700 + installation: *672 + organization: *673 + projects_v2: *714 sender: *4 required: - action @@ -147166,9 +147208,9 @@ x-webhooks: type: string enum: - created - installation: *658 - organization: *659 - projects_v2_status_update: &705 + installation: *672 + organization: *673 + projects_v2_status_update: &719 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -147295,9 +147337,9 @@ x-webhooks: type: string enum: - deleted - installation: *658 - organization: *659 - projects_v2_status_update: *705 + installation: *672 + organization: *673 + projects_v2_status_update: *719 sender: *4 required: - action @@ -147433,9 +147475,9 @@ x-webhooks: type: string format: date nullable: true - installation: *658 - organization: *659 - projects_v2_status_update: *705 + installation: *672 + organization: *673 + projects_v2_status_update: *719 sender: *4 required: - action @@ -147506,10 +147548,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - repository @@ -147586,13 +147628,13 @@ x-webhooks: type: string enum: - assigned - assignee: *677 - enterprise: *657 - installation: *658 - number: &706 + assignee: *691 + enterprise: *671 + installation: *672 + number: &720 description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -149875,7 +149917,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -149957,11 +149999,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -152239,7 +152281,7 @@ x-webhooks: - draft reason: type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -152321,11 +152363,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -154603,7 +154645,7 @@ x-webhooks: - draft reason: type: string - repository: *660 + repository: *674 sender: *4 required: - action @@ -154685,11 +154727,11 @@ x-webhooks: type: string enum: - closed - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: &707 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: &721 allOf: - *524 - type: object @@ -154753,7 +154795,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *660 + repository: *674 sender: *4 required: - action @@ -154834,12 +154876,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -154919,11 +154961,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *657 + enterprise: *671 milestone: *507 - number: *706 - organization: *659 - pull_request: &708 + number: *720 + organization: *673 + pull_request: &722 title: Pull Request type: object properties: @@ -157186,7 +157228,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -157265,11 +157307,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -159551,7 +159593,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *660 + repository: *674 sender: *4 required: - action @@ -159675,12 +159717,12 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -159760,11 +159802,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -162031,7 +162073,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -162111,11 +162153,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *657 - installation: *658 - label: *676 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + label: *690 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -164397,7 +164439,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -164478,10 +164520,10 @@ x-webhooks: type: string enum: - locked - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -166761,7 +166803,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -166841,12 +166883,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *657 + enterprise: *671 milestone: *507 - number: *706 - organization: *659 - pull_request: *708 - repository: *660 + number: *720 + organization: *673 + pull_request: *722 + repository: *674 sender: *4 required: - action @@ -166925,12 +166967,12 @@ x-webhooks: type: string enum: - opened - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167011,12 +167053,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167096,12 +167138,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *657 - installation: *658 - number: *706 - organization: *659 - pull_request: *707 - repository: *660 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 + pull_request: *721 + repository: *674 sender: *4 required: - action @@ -167467,9 +167509,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -169639,7 +169681,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -169719,7 +169761,7 @@ x-webhooks: type: string enum: - deleted - comment: &710 + comment: &724 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -170004,9 +170046,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -172164,7 +172206,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -172244,11 +172286,11 @@ x-webhooks: type: string enum: - edited - changes: *709 - comment: *710 - enterprise: *657 - installation: *658 - organization: *659 + changes: *723 + comment: *724 + enterprise: *671 + installation: *672 + organization: *673 pull_request: type: object properties: @@ -174409,7 +174451,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *660 + repository: *674 sender: *4 required: - action @@ -174490,9 +174532,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -176665,7 +176707,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 review: description: The review that was affected. type: object @@ -176908,9 +176950,9 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -178964,8 +179006,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 - review: &711 + repository: *674 + review: &725 description: The review that was affected. type: object properties: @@ -179194,12 +179236,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -181482,7 +181524,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_reviewer: title: User type: object @@ -181566,12 +181608,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -183861,7 +183903,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_team: title: Team description: Groups of organization members that gives permissions @@ -184053,12 +184095,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -186343,7 +186385,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_reviewer: title: User type: object @@ -186428,12 +186470,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *657 - installation: *658 + enterprise: *671 + installation: *672 number: description: The pull request number. type: integer - organization: *659 + organization: *673 pull_request: title: Pull Request type: object @@ -188709,7 +188751,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188890,9 +188932,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -191067,8 +191109,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 - review: *711 + repository: *674 + review: *725 sender: *4 required: - action @@ -191148,9 +191190,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -193220,7 +193262,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 sender: *4 thread: type: object @@ -193603,9 +193645,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 pull_request: title: Simple Pull Request type: object @@ -195661,7 +195703,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *660 + repository: *674 sender: *4 thread: type: object @@ -196047,10 +196089,10 @@ x-webhooks: type: string before: type: string - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -198321,7 +198363,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -198403,11 +198445,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *712 - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + assignee: *726 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -200690,7 +200732,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -200769,11 +200811,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *657 - installation: *658 - label: *676 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + label: *690 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -203046,7 +203088,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -203127,10 +203169,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *657 - installation: *658 - number: *706 - organization: *659 + enterprise: *671 + installation: *672 + number: *720 + organization: *673 pull_request: title: Pull Request type: object @@ -205395,7 +205437,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *660 + repository: *674 sender: *4 required: - action @@ -205595,7 +205637,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *657 + enterprise: *671 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -205687,8 +205729,8 @@ x-webhooks: - url - author - committer - installation: *658 - organization: *659 + installation: *672 + organization: *673 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -206263,9 +206305,9 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 registry_package: type: object properties: @@ -206711,7 +206753,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *694 + items: *708 summary: type: string tag_name: @@ -206765,7 +206807,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -206843,9 +206885,9 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 registry_package: type: object properties: @@ -207153,7 +207195,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *694 + items: *708 summary: type: string tag_name: @@ -207202,7 +207244,7 @@ x-webhooks: - owner - package_version - registry - repository: *660 + repository: *674 sender: *4 required: - action @@ -207279,10 +207321,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - release: &713 + enterprise: *671 + installation: *672 + organization: *673 + release: &727 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -207591,7 +207633,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *660 + repository: *674 sender: *4 required: - action @@ -207668,11 +207710,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -207789,11 +207831,11 @@ x-webhooks: type: boolean required: - to - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -207871,9 +207913,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -208186,7 +208228,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *660 + repository: *674 sender: *4 required: - action @@ -208262,10 +208304,10 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - release: &714 + enterprise: *671 + installation: *672 + organization: *673 + release: &728 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208575,7 +208617,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *660 + repository: *674 sender: *4 required: - action @@ -208651,11 +208693,11 @@ x-webhooks: type: string enum: - released - enterprise: *657 - installation: *658 - organization: *659 - release: *713 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *727 + repository: *674 sender: *4 required: - action @@ -208731,11 +208773,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *657 - installation: *658 - organization: *659 - release: *714 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + release: *728 + repository: *674 sender: *4 required: - action @@ -208811,11 +208853,11 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - repository_advisory: *584 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + repository_advisory: *598 sender: *4 required: - action @@ -208891,11 +208933,11 @@ x-webhooks: type: string enum: - reported - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - repository_advisory: *584 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + repository_advisory: *598 sender: *4 required: - action @@ -208971,10 +209013,10 @@ x-webhooks: type: string enum: - archived - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209051,10 +209093,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209132,10 +209174,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209219,10 +209261,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209334,10 +209376,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209409,10 +209451,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 status: type: string @@ -209493,10 +209535,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209573,10 +209615,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209670,10 +209712,10 @@ x-webhooks: - name required: - repository - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -209753,10 +209795,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 sender: *4 required: @@ -209835,10 +209877,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 sender: *4 required: @@ -209917,10 +209959,10 @@ x-webhooks: type: string enum: - edited - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 repository_ruleset: *245 changes: type: object @@ -210225,10 +210267,10 @@ x-webhooks: - from required: - owner - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210306,10 +210348,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210387,7 +210429,7 @@ x-webhooks: type: string enum: - create - alert: &715 + alert: &729 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -210508,10 +210550,10 @@ x-webhooks: type: string enum: - open - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210717,10 +210759,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -210798,11 +210840,11 @@ x-webhooks: type: string enum: - reopen - alert: *715 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *729 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211001,10 +211043,10 @@ x-webhooks: enum: - fixed - open - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211082,7 +211124,7 @@ x-webhooks: type: string enum: - created - alert: &716 + alert: &730 type: object properties: number: *54 @@ -211193,10 +211235,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211277,11 +211319,11 @@ x-webhooks: type: string enum: - created - alert: *716 - installation: *658 - location: *717 - organization: *659 - repository: *660 + alert: *730 + installation: *672 + location: *731 + organization: *673 + repository: *674 sender: *4 required: - location @@ -211519,11 +211561,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211601,11 +211643,11 @@ x-webhooks: type: string enum: - reopened - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211683,11 +211725,11 @@ x-webhooks: type: string enum: - resolved - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211765,11 +211807,11 @@ x-webhooks: type: string enum: - validated - alert: *716 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + alert: *730 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -211895,10 +211937,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *660 - enterprise: *657 - installation: *658 - organization: *659 + repository: *674 + enterprise: *671 + installation: *672 + organization: *673 sender: *4 required: - action @@ -211976,11 +212018,11 @@ x-webhooks: type: string enum: - published - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - security_advisory: &718 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + security_advisory: &732 description: The details of the security advisory, including summary, description, and severity. type: object @@ -212163,11 +212205,11 @@ x-webhooks: type: string enum: - updated - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 - security_advisory: *718 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 + security_advisory: *732 sender: *4 required: - action @@ -212240,10 +212282,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -212428,9 +212470,9 @@ x-webhooks: type: object properties: security_and_analysis: *238 - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: *292 sender: *4 required: @@ -212509,12 +212551,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: &719 + sponsorship: &733 type: object properties: created_at: @@ -212815,12 +212857,12 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - sponsorship @@ -212908,12 +212950,12 @@ x-webhooks: type: string required: - from - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -212990,17 +213032,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &720 + effective_date: &734 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - sponsorship @@ -213074,7 +213116,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &721 + changes: &735 type: object properties: tier: @@ -213118,13 +213160,13 @@ x-webhooks: - from required: - tier - effective_date: *720 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + effective_date: *734 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -213201,13 +213243,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *721 - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + changes: *735 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - sponsorship: *719 + sponsorship: *733 required: - action - changes @@ -213281,10 +213323,10 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213367,10 +213409,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213790,15 +213832,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *657 + enterprise: *671 id: description: The unique identifier of the status. type: integer - installation: *658 + installation: *672 name: type: string - organization: *659 - repository: *660 + organization: *673 + repository: *674 sender: *4 sha: description: The Commit SHA. @@ -213913,9 +213955,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214005,9 +214047,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214097,9 +214139,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214189,9 +214231,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *658 - organization: *659 - repository: *660 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -214268,12 +214310,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - team: &722 + team: &736 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -214463,9 +214505,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -214923,7 +214965,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -214999,9 +215041,9 @@ x-webhooks: type: string enum: - created - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -215459,7 +215501,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -215536,9 +215578,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -215996,7 +216038,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -216140,9 +216182,9 @@ x-webhooks: - from required: - permissions - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -216600,7 +216642,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - changes @@ -216678,9 +216720,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *657 - installation: *658 - organization: *659 + enterprise: *671 + installation: *672 + organization: *673 repository: title: Repository description: A git repository @@ -217138,7 +217180,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *722 + team: *736 required: - action - team @@ -217214,10 +217256,10 @@ x-webhooks: type: string enum: - started - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 required: - action @@ -217290,16 +217332,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *657 + enterprise: *671 inputs: type: object nullable: true additionalProperties: true - installation: *658 - organization: *659 + installation: *672 + organization: *673 ref: type: string - repository: *660 + repository: *674 sender: *4 workflow: type: string @@ -217381,10 +217423,10 @@ x-webhooks: type: string enum: - completed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: allOf: @@ -217700,10 +217742,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: allOf: @@ -218042,10 +218084,10 @@ x-webhooks: type: string enum: - queued - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: type: object @@ -218259,10 +218301,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 workflow_job: type: object @@ -218478,12 +218520,12 @@ x-webhooks: type: string enum: - completed - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object @@ -219482,12 +219524,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object @@ -220471,12 +220513,12 @@ x-webhooks: type: string enum: - requested - enterprise: *657 - installation: *658 - organization: *659 - repository: *660 + enterprise: *671 + installation: *672 + organization: *673 + repository: *674 sender: *4 - workflow: *672 + workflow: *686 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index bb8e48f938..cba86773f3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -46921,6 +46921,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -170551,6 +170836,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -458042,6 +458612,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -458758,6 +459613,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, @@ -459427,6 +460567,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index f3dbc28b41..e1603eea30 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1025,7 +1025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &674 + - &688 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1709,7 +1709,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &684 + schema: &698 title: Scim Error description: Scim Error type: object @@ -17737,6 +17737,275 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &668 + - &670 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &671 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &672 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &673 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &674 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &675 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &676 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &677 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &678 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &679 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &680 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &681 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &682 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true examples: default: &344 value: @@ -19835,7 +20104,7 @@ paths: url: type: string format: uri - user: &723 + user: &737 title: Public User description: Public User type: object @@ -24276,7 +24545,7 @@ paths: type: array items: *59 examples: - default: &741 + default: &755 value: - login: github id: 1 @@ -26098,7 +26367,7 @@ paths: type: array items: *64 examples: - default: &735 + default: &749 value: total_count: 1 repositories: @@ -26917,7 +27186,7 @@ paths: type: array items: *198 examples: - default: &726 + default: &740 value: total_count: 1 repositories: @@ -38451,7 +38720,7 @@ paths: parameters: - *172 - *301 - - &740 + - &754 name: repo_name description: repo_name parameter in: path @@ -39766,7 +40035,7 @@ paths: - nuget - container - *172 - - &742 + - &756 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39807,7 +40076,7 @@ paths: default: *308 '403': *29 '401': *25 - '400': &744 + '400': &758 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -44321,7 +44590,7 @@ paths: application/json: schema: type: array - items: &672 + items: &686 description: A repository security advisory. type: object properties: @@ -44612,7 +44881,7 @@ paths: - private_fork additionalProperties: false examples: - default: &673 + default: &687 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -46375,7 +46644,7 @@ paths: - updated_at - url examples: - default: &713 + default: &727 value: - author: login: octocat @@ -46623,7 +46892,7 @@ paths: application/json: schema: *362 examples: - default: &714 + default: &728 value: author: login: octocat @@ -46806,7 +47075,7 @@ paths: - updated_at - url examples: - default: &715 + default: &729 value: - author: login: octocat @@ -47032,7 +47301,7 @@ paths: application/json: schema: *365 examples: - default: &716 + default: &730 value: author: login: octocat @@ -47745,7 +48014,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &717 + response-if-user-is-a-team-maintainer: &731 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47810,7 +48079,7 @@ paths: application/json: schema: *376 examples: - response-if-users-membership-with-team-is-now-pending: &718 + response-if-users-membership-with-team-is-now-pending: &732 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47951,7 +48220,7 @@ paths: - updated_at - permissions examples: - default: &719 + default: &733 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48030,7 +48299,7 @@ paths: application/json: schema: *377 examples: - default: &720 + default: &734 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48240,7 +48509,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &721 + schema: &735 title: Team Repository description: A team's access to a repository. type: object @@ -49006,7 +49275,7 @@ paths: type: array items: *229 examples: - response-if-child-teams-exist: &722 + response-if-child-teams-exist: &736 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -61187,7 +61456,7 @@ paths: check. type: array items: *451 - deployment: &773 + deployment: &787 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -62099,7 +62368,7 @@ paths: type: string format: date-time nullable: true - head_commit: &799 + head_commit: &813 title: Simple Commit description: A commit. type: object @@ -66319,14 +66588,14 @@ paths: type: integer machines: type: array - items: &729 + items: &743 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *490 required: *491 examples: - default: &730 + default: &744 value: total_count: 2 machines: @@ -69626,7 +69895,7 @@ paths: application/json: schema: type: array - items: &677 + items: &691 title: Status description: The status of a commit. type: object @@ -71182,7 +71451,7 @@ paths: items: type: object properties: - placeholder_id: &669 + placeholder_id: &683 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -77120,7 +77389,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &807 + last_response: &821 title: Hook Response type: object properties: @@ -78080,7 +78349,7 @@ paths: parameters: - *379 - *380 - - &753 + - &767 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -78514,7 +78783,7 @@ paths: type: array items: *568 examples: - default: &746 + default: &760 value: - id: 1 repository: @@ -92256,7 +92525,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 type: object properties: number: *100 @@ -92366,6 +92635,14 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *668 + nullable: true examples: default: value: @@ -92503,7 +92780,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -92584,7 +92861,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -92672,7 +92949,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &828 + items: &842 type: object properties: type: @@ -92698,254 +92975,19 @@ paths: example: commit details: oneOf: - - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url + - *670 + - *671 + - *672 + - *673 + - *674 + - *675 + - *676 + - *677 + - *678 + - *679 + - *680 + - *681 + - *682 examples: default: value: @@ -93040,14 +93082,14 @@ paths: schema: type: object properties: - reason: &670 + reason: &684 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *669 + placeholder_id: *683 required: - reason - placeholder_id @@ -93064,7 +93106,7 @@ paths: schema: type: object properties: - reason: *670 + reason: *684 expire_at: type: string format: date-time @@ -93123,7 +93165,7 @@ paths: properties: incremental_scans: type: array - items: &671 + items: &685 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93149,15 +93191,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *671 + items: *685 backfill_scans: type: array - items: *671 + items: *685 custom_pattern_backfill_scans: type: array items: allOf: - - *671 + - *685 - type: object properties: pattern_name: @@ -93272,9 +93314,9 @@ paths: application/json: schema: type: array - items: *672 + items: *686 examples: - default: *673 + default: *687 '400': *14 '404': *6 x-github: @@ -93458,9 +93500,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: &675 + default: &689 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -93798,7 +93840,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: default: value: @@ -93947,15 +93989,15 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '200': description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: *675 + default: *689 '403': *29 '404': *6 x-github: @@ -93981,7 +94023,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 requestBody: required: true content: @@ -94140,10 +94182,10 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: *675 - add_credit: *675 + default: *689 + add_credit: *689 '403': *29 '404': *6 '422': @@ -94183,7 +94225,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '202': *39 '400': *14 @@ -94212,7 +94254,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '202': description: Response @@ -94356,7 +94398,7 @@ paths: application/json: schema: type: array - items: &676 + items: &690 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94729,7 +94771,7 @@ paths: application/json: schema: type: array - items: *676 + items: *690 examples: default: value: @@ -94817,7 +94859,7 @@ paths: description: Response content: application/json: - schema: *677 + schema: *691 examples: default: value: @@ -94911,7 +94953,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &678 + schema: &692 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95006,7 +95048,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *692 examples: default: value: @@ -95143,7 +95185,7 @@ paths: application/json: schema: type: array - items: &679 + items: &693 title: Tag protection description: Tag protection type: object @@ -95219,7 +95261,7 @@ paths: description: Response content: application/json: - schema: *679 + schema: *693 examples: default: value: @@ -95367,7 +95409,7 @@ paths: description: Response content: application/json: - schema: &680 + schema: &694 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95379,7 +95421,7 @@ paths: required: - names examples: - default: &681 + default: &695 value: names: - octocat @@ -95434,9 +95476,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *694 examples: - default: *681 + default: *695 '404': *6 '422': *7 x-github: @@ -95459,7 +95501,7 @@ paths: parameters: - *379 - *380 - - &682 + - &696 name: per description: The time frame to display results for. in: query @@ -95488,7 +95530,7 @@ paths: example: 128 clones: type: array - items: &683 + items: &697 title: Traffic type: object properties: @@ -95729,7 +95771,7 @@ paths: parameters: - *379 - *380 - - *682 + - *696 responses: '200': description: Response @@ -95748,7 +95790,7 @@ paths: example: 3782 views: type: array - items: *683 + items: *697 required: - uniques - count @@ -96420,7 +96462,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &691 + - &705 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -96429,7 +96471,7 @@ paths: schema: type: string example: members - - &696 + - &710 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -96440,7 +96482,7 @@ paths: default: 1 format: int32 example: 1 - - &697 + - &711 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -96482,7 +96524,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &685 + items: &699 allOf: - type: object required: @@ -96557,7 +96599,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &698 + meta: &712 type: object description: The metadata associated with the creation/updates to the user. @@ -96617,31 +96659,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &686 + '400': &700 description: Bad request content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '401': &687 + schema: *698 + '401': &701 description: Authorization failure - '403': &688 + '403': &702 description: Permission denied - '429': &689 + '429': &703 description: Too many requests content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '500': &690 + schema: *698 + '500': &704 description: Internal server error content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 + schema: *698 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96665,7 +96707,7 @@ paths: required: true content: application/json: - schema: &694 + schema: &708 type: object required: - schemas @@ -96721,9 +96763,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *685 + schema: *699 examples: - group: &692 + group: &706 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -96742,13 +96784,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *686 - '401': *687 - '403': *688 - '409': &695 + '400': *700 + '401': *701 + '403': *702 + '409': &709 description: Duplicate record detected - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96765,7 +96807,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &693 + - &707 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -96773,22 +96815,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *691 + - *705 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *685 + schema: *699 examples: - default: *692 - '400': *686 - '401': *687 - '403': *688 + default: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96807,13 +96849,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *693 + - *707 - *41 requestBody: required: true content: application/json: - schema: *694 + schema: *708 examples: group: summary: Group @@ -96839,17 +96881,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *685 + schema: *699 examples: - group: *692 - groupWithMembers: *692 - '400': *686 - '401': *687 - '403': *688 + group: *706 + groupWithMembers: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96873,13 +96915,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *693 + - *707 - *41 requestBody: required: true content: application/json: - schema: &705 + schema: &719 type: object required: - Operations @@ -96939,17 +96981,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *685 + schema: *699 examples: - updateGroup: *692 - addMembers: *692 - '400': *686 - '401': *687 - '403': *688 + updateGroup: *706 + addMembers: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96965,17 +97007,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *693 + - *707 - *41 responses: '204': description: Group was deleted, no content - '400': *686 - '401': *687 - '403': *688 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97009,8 +97051,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *696 - - *697 + - *710 + - *711 - *41 responses: '200': @@ -97043,7 +97085,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &700 + items: &714 allOf: - type: object required: @@ -97122,7 +97164,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &699 + roles: &713 type: array description: The roles assigned to the user. items: @@ -97178,7 +97220,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *698 + meta: *712 startIndex: type: integer description: A starting index for the returned page @@ -97215,11 +97257,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *686 - '401': *687 - '403': *688 - '429': *689 - '500': *690 + '400': *700 + '401': *701 + '403': *702 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97243,7 +97285,7 @@ paths: required: true content: application/json: - schema: &703 + schema: &717 type: object required: - schemas @@ -97325,9 +97367,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *699 + roles: *713 examples: - user: &704 + user: &718 summary: User value: schemas: @@ -97374,9 +97416,9 @@ paths: description: User has been created content: application/scim+json: - schema: *700 + schema: *714 examples: - user: &701 + user: &715 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -97402,13 +97444,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *701 - '400': *686 - '401': *687 - '403': *688 - '409': *695 - '429': *689 - '500': *690 + enterpriseOwner: *715 + '400': *700 + '401': *701 + '403': *702 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97425,7 +97467,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &702 + - &716 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -97438,15 +97480,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *700 + schema: *714 examples: - default: *701 - '400': *686 - '401': *687 - '403': *688 + default: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97468,30 +97510,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *702 + - *716 - *41 requestBody: required: true content: application/json: - schema: *703 + schema: *717 examples: - user: *704 + user: *718 responses: '200': description: User was updated content: application/scim+json: - schema: *700 + schema: *714 examples: - user: *701 - '400': *686 - '401': *687 - '403': *688 + user: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97526,13 +97568,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *702 + - *716 - *41 requestBody: required: true content: application/json: - schema: *705 + schema: *719 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -97572,18 +97614,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *700 - examples: - userMultiValuedProperties: *701 - userSingleValuedProperties: *701 - disableUser: *701 - '400': *686 - '401': *687 - '403': *688 + schema: *714 + examples: + userMultiValuedProperties: *715 + userSingleValuedProperties: *715 + disableUser: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97603,17 +97645,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *702 + - *716 - *41 responses: '204': description: User was deleted, no content - '400': *686 - '401': *687 - '403': *688 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97700,7 +97742,7 @@ paths: example: 1 Resources: type: array - items: &706 + items: &720 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -97931,22 +97973,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &707 + '404': &721 description: Resource not found content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '403': &708 + schema: *698 + '403': &722 description: Forbidden content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '400': *686 - '429': *689 + schema: *698 + '400': *700 + '429': *703 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -97972,9 +98014,9 @@ paths: description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: &709 + default: &723 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -97997,17 +98039,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *707 - '403': *708 - '500': *690 + '404': *721 + '403': *722 + '500': *704 '409': description: Conflict content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '400': *686 + schema: *698 + '400': *700 requestBody: required: true content: @@ -98105,17 +98147,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 - '404': *707 - '403': *708 + default: *723 + '404': *721 + '403': *722 '304': *37 x-github: githubCloudOnly: true @@ -98139,18 +98181,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 + default: *723 '304': *37 - '404': *707 - '403': *708 + '404': *721 + '403': *722 requestBody: required: true content: @@ -98263,19 +98305,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 + default: *723 '304': *37 - '404': *707 - '403': *708 - '400': *686 + '404': *721 + '403': *722 + '400': *700 '429': description: Response content: @@ -98366,12 +98408,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *172 - - *702 + - *716 responses: '204': description: Response - '404': *707 - '403': *708 + '404': *721 + '403': *722 '304': *37 x-github: githubCloudOnly: true @@ -98504,7 +98546,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &710 + text_matches: &724 title: Search Result Text Matches type: array items: @@ -98667,7 +98709,7 @@ paths: enum: - author-date - committer-date - - &711 + - &725 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -98795,7 +98837,7 @@ paths: type: number node_id: type: string - text_matches: *710 + text_matches: *724 required: - sha - node_id @@ -98978,7 +99020,7 @@ paths: - interactions - created - updated - - *711 + - *725 - *17 - *19 - name: advanced_search @@ -99120,7 +99162,7 @@ paths: type: string format: date-time nullable: true - text_matches: *710 + text_matches: *724 pull_request: type: object properties: @@ -99348,7 +99390,7 @@ paths: enum: - created - updated - - *711 + - *725 - *17 - *19 responses: @@ -99392,7 +99434,7 @@ paths: nullable: true score: type: number - text_matches: *710 + text_matches: *724 required: - id - node_id @@ -99478,7 +99520,7 @@ paths: - forks - help-wanted-issues - updated - - *711 + - *725 - *17 - *19 responses: @@ -99717,7 +99759,7 @@ paths: - admin - pull - push - text_matches: *710 + text_matches: *724 temp_clone_token: type: string allow_merge_commit: @@ -100018,7 +100060,7 @@ paths: type: string format: uri nullable: true - text_matches: *710 + text_matches: *724 related: type: array nullable: true @@ -100211,7 +100253,7 @@ paths: - followers - repositories - joined - - *711 + - *725 - *17 - *19 responses: @@ -100315,7 +100357,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *710 + text_matches: *724 blog: type: string nullable: true @@ -100394,7 +100436,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &712 + - &726 name: team_id description: The unique identifier of the team. in: path @@ -100435,7 +100477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -100535,7 +100577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *712 + - *726 responses: '204': description: Response @@ -100566,7 +100608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *712 + - *726 - *88 - *17 - *19 @@ -100579,7 +100621,7 @@ paths: type: array items: *362 examples: - default: *713 + default: *727 headers: Link: *40 x-github: @@ -100608,7 +100650,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -100671,7 +100713,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *712 + - *726 - *364 responses: '200': @@ -100705,7 +100747,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *712 + - *726 - *364 requestBody: required: false @@ -100731,7 +100773,7 @@ paths: application/json: schema: *362 examples: - default: *714 + default: *728 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100756,7 +100798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *712 + - *726 - *364 responses: '204': @@ -100786,7 +100828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *712 + - *726 - *364 - *88 - *17 @@ -100800,7 +100842,7 @@ paths: type: array items: *365 examples: - default: *715 + default: *729 headers: Link: *40 x-github: @@ -100829,7 +100871,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 requestBody: required: true @@ -100881,7 +100923,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 responses: @@ -100916,7 +100958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 requestBody: @@ -100942,7 +100984,7 @@ paths: application/json: schema: *365 examples: - default: *716 + default: *730 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100967,7 +101009,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 responses: @@ -100998,7 +101040,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 - name: content @@ -101057,7 +101099,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 requestBody: @@ -101119,7 +101161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *712 + - *726 - *364 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -101177,7 +101219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *712 + - *726 - *364 requestBody: required: true @@ -101236,7 +101278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101274,7 +101316,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *712 + - *726 - name: role description: Filters members returned by their role in the team. in: query @@ -101325,7 +101367,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101362,7 +101404,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101402,7 +101444,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101439,7 +101481,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 responses: '200': @@ -101448,7 +101490,7 @@ paths: application/json: schema: *376 examples: - response-if-user-is-a-team-maintainer: *717 + response-if-user-is-a-team-maintainer: *731 '404': *6 x-github: githubCloudOnly: false @@ -101481,7 +101523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 requestBody: required: false @@ -101509,7 +101551,7 @@ paths: application/json: schema: *376 examples: - response-if-users-membership-with-team-is-now-pending: *718 + response-if-users-membership-with-team-is-now-pending: *732 '403': description: Forbidden if team synchronization is set up '422': @@ -101543,7 +101585,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101572,7 +101614,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101584,7 +101626,7 @@ paths: type: array items: *377 examples: - default: *719 + default: *733 headers: Link: *40 '404': *6 @@ -101610,7 +101652,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *712 + - *726 - *378 responses: '200': @@ -101619,7 +101661,7 @@ paths: application/json: schema: *377 examples: - default: *720 + default: *734 '404': description: Not Found if project is not managed by this team x-github: @@ -101643,7 +101685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *712 + - *726 - *378 requestBody: required: false @@ -101711,7 +101753,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *712 + - *726 - *378 responses: '204': @@ -101739,7 +101781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101781,7 +101823,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *712 + - *726 - *379 - *380 responses: @@ -101789,7 +101831,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *721 + schema: *735 examples: alternative-response-with-extra-repository-information: value: @@ -101940,7 +101982,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *712 + - *726 - *379 - *380 requestBody: @@ -101992,7 +102034,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *712 + - *726 - *379 - *380 responses: @@ -102023,7 +102065,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *712 + - *726 responses: '200': description: Response @@ -102058,7 +102100,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -102146,7 +102188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -102158,7 +102200,7 @@ paths: type: array items: *229 examples: - response-if-child-teams-exist: *722 + response-if-child-teams-exist: *736 headers: Link: *40 '404': *6 @@ -102191,7 +102233,7 @@ paths: application/json: schema: oneOf: - - &724 + - &738 title: Private User description: Private User type: object @@ -102394,7 +102436,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *723 + - *737 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -102547,7 +102589,7 @@ paths: description: Response content: application/json: - schema: *724 + schema: *738 examples: default: value: @@ -102945,7 +102987,7 @@ paths: type: integer secrets: type: array - items: &725 + items: &739 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -103061,7 +103103,7 @@ paths: description: Response content: application/json: - schema: *725 + schema: *739 examples: default: value: @@ -103207,7 +103249,7 @@ paths: type: array items: *198 examples: - default: *726 + default: *740 '401': *25 '403': *29 '404': *6 @@ -103474,7 +103516,7 @@ paths: description: Response content: application/json: - schema: &727 + schema: &741 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -103515,7 +103557,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &728 + default: &742 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -103560,9 +103602,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *741 examples: - default: *728 + default: *742 '404': *6 x-github: githubCloudOnly: false @@ -103599,9 +103641,9 @@ paths: type: integer machines: type: array - items: *729 + items: *743 examples: - default: *730 + default: *744 '304': *37 '500': *85 '401': *25 @@ -104540,7 +104582,7 @@ paths: type: array items: *307 examples: - default: &743 + default: &757 value: - id: 197 name: hello_docker @@ -104641,7 +104683,7 @@ paths: application/json: schema: type: array - items: &731 + items: &745 title: Email description: Email type: object @@ -104706,9 +104748,9 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: - default: &745 + default: &759 value: - email: octocat@github.com verified: true @@ -104783,7 +104825,7 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: default: value: @@ -105039,7 +105081,7 @@ paths: application/json: schema: type: array - items: &732 + items: &746 title: GPG Key description: A unique encryption key type: object @@ -105170,7 +105212,7 @@ paths: - subkeys - revoked examples: - default: &756 + default: &770 value: - id: 3 name: Octocat's GPG Key @@ -105255,9 +105297,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *746 examples: - default: &733 + default: &747 value: id: 3 name: Octocat's GPG Key @@ -105314,7 +105356,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &734 + - &748 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -105326,9 +105368,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *746 examples: - default: *733 + default: *747 '404': *6 '304': *37 '403': *29 @@ -105351,7 +105393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *734 + - *748 responses: '204': description: Response @@ -105542,7 +105584,7 @@ paths: type: array items: *64 examples: - default: *735 + default: *749 headers: Link: *40 '404': *6 @@ -105806,7 +105848,7 @@ paths: application/json: schema: type: array - items: &736 + items: &750 title: Key description: Key type: object @@ -105903,9 +105945,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *750 examples: - default: &737 + default: &751 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105944,9 +105986,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *750 examples: - default: *737 + default: *751 '404': *6 '304': *37 '403': *29 @@ -106002,7 +106044,7 @@ paths: application/json: schema: type: array - items: &738 + items: &752 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -106070,7 +106112,7 @@ paths: - account - plan examples: - default: &739 + default: &753 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -106132,9 +106174,9 @@ paths: application/json: schema: type: array - items: *738 + items: *752 examples: - default: *739 + default: *753 headers: Link: *40 '304': *37 @@ -107129,7 +107171,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *301 - - *740 + - *754 responses: '204': description: Response @@ -107202,7 +107244,7 @@ paths: type: array items: *59 examples: - default: *741 + default: *755 headers: Link: *40 '304': *37 @@ -107244,7 +107286,7 @@ paths: - docker - nuget - container - - *742 + - *756 - *19 - *17 responses: @@ -107256,8 +107298,8 @@ paths: type: array items: *307 examples: - default: *743 - '400': *744 + default: *757 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107286,7 +107328,7 @@ paths: application/json: schema: *307 examples: - default: &757 + default: &771 value: id: 40201 name: octo-name @@ -107739,9 +107781,9 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: - default: *745 + default: *759 headers: Link: *40 '304': *37 @@ -107854,7 +107896,7 @@ paths: type: array items: *64 examples: - default: &752 + default: &766 summary: Default response value: - id: 1296269 @@ -108200,7 +108242,7 @@ paths: type: array items: *568 examples: - default: *746 + default: *760 headers: Link: *40 '304': *37 @@ -108279,7 +108321,7 @@ paths: application/json: schema: type: array - items: &747 + items: &761 title: Social account description: Social media account type: object @@ -108294,7 +108336,7 @@ paths: - provider - url examples: - default: &748 + default: &762 value: - provider: twitter url: https://twitter.com/github @@ -108356,9 +108398,9 @@ paths: application/json: schema: type: array - items: *747 + items: *761 examples: - default: *748 + default: *762 '422': *15 '304': *37 '404': *6 @@ -108445,7 +108487,7 @@ paths: application/json: schema: type: array - items: &749 + items: &763 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -108465,7 +108507,7 @@ paths: - title - created_at examples: - default: &758 + default: &772 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108531,9 +108573,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *763 examples: - default: &750 + default: &764 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108564,7 +108606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &751 + - &765 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -108576,9 +108618,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *763 examples: - default: *750 + default: *764 '404': *6 '304': *37 '403': *29 @@ -108601,7 +108643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *751 + - *765 responses: '204': description: Response @@ -108630,7 +108672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &759 + - &773 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -108655,11 +108697,11 @@ paths: type: array items: *64 examples: - default-response: *752 + default-response: *766 application/vnd.github.v3.star+json: schema: type: array - items: &760 + items: &774 title: Starred Repository description: Starred Repository type: object @@ -109028,10 +109070,10 @@ paths: application/json: schema: oneOf: - - *724 - - *723 + - *738 + - *737 examples: - default-response: &754 + default-response: &768 summary: Default response value: login: octocat @@ -109066,7 +109108,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &755 + response-with-git-hub-plan-information: &769 summary: Response with GitHub plan information value: login: octocat @@ -109126,7 +109168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *753 + - *767 - *17 responses: '200': @@ -109175,11 +109217,11 @@ paths: application/json: schema: oneOf: - - *724 - - *723 + - *738 + - *737 examples: - default-response: *754 - response-with-git-hub-plan-information: *755 + default-response: *768 + response-with-git-hub-plan-information: *769 '404': *6 x-github: githubCloudOnly: false @@ -109296,7 +109338,7 @@ paths: type: array items: *307 examples: - default: *743 + default: *757 '403': *29 '401': *25 x-github: @@ -109700,9 +109742,9 @@ paths: application/json: schema: type: array - items: *732 + items: *746 examples: - default: *756 + default: *770 headers: Link: *40 x-github: @@ -109884,7 +109926,7 @@ paths: type: array items: *59 examples: - default: *741 + default: *755 headers: Link: *40 x-github: @@ -109923,7 +109965,7 @@ paths: - docker - nuget - container - - *742 + - *756 - *220 - *19 - *17 @@ -109936,10 +109978,10 @@ paths: type: array items: *307 examples: - default: *743 + default: *757 '403': *29 '401': *25 - '400': *744 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109969,7 +110011,7 @@ paths: application/json: schema: *307 examples: - default: *757 + default: *771 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110753,9 +110795,9 @@ paths: application/json: schema: type: array - items: *747 + items: *761 examples: - default: *748 + default: *762 headers: Link: *40 x-github: @@ -110785,9 +110827,9 @@ paths: application/json: schema: type: array - items: *749 + items: *763 examples: - default: *758 + default: *772 headers: Link: *40 x-github: @@ -110812,7 +110854,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *220 - - *759 + - *773 - *88 - *17 - *19 @@ -110824,11 +110866,11 @@ paths: schema: anyOf: - type: array - items: *760 + items: *774 - type: array items: *64 examples: - default-response: *752 + default-response: *766 headers: Link: *40 x-github: @@ -110987,7 +111029,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &761 + enterprise: &775 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -111045,7 +111087,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &762 + installation: &776 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -111064,7 +111106,7 @@ x-webhooks: required: - id - node_id - organization: &763 + organization: &777 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -111124,13 +111166,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &764 + repository: &778 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &801 + properties: &815 id: description: Unique identifier of the repository example: 42 @@ -111813,7 +111855,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &802 + required: &816 - archive_url - assignees_url - blobs_url @@ -111964,10 +112006,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -112043,11 +112085,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: &765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: &779 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -112270,11 +112312,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: *765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: *779 sender: *4 required: - action @@ -112457,11 +112499,11 @@ x-webhooks: - everyone required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: *765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: *779 sender: *4 required: - action @@ -112532,7 +112574,7 @@ x-webhooks: required: true content: application/json: - schema: &768 + schema: &782 title: Exemption request cancellation event type: object properties: @@ -112540,11 +112582,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: &766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: &780 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -112777,7 +112819,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &767 + items: &781 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -112885,7 +112927,7 @@ x-webhooks: required: true content: application/json: - schema: &769 + schema: &783 title: Exemption request completed event type: object properties: @@ -112893,11 +112935,11 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 sender: *4 required: - action @@ -112967,7 +113009,7 @@ x-webhooks: required: true content: application/json: - schema: &770 + schema: &784 title: Exemption request created event type: object properties: @@ -112975,11 +113017,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 sender: *4 required: - action @@ -113049,7 +113091,7 @@ x-webhooks: required: true content: application/json: - schema: &771 + schema: &785 title: Exemption response dismissed event type: object properties: @@ -113057,12 +113099,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 - exemption_response: *767 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 + exemption_response: *781 sender: *4 required: - action @@ -113134,7 +113176,7 @@ x-webhooks: required: true content: application/json: - schema: &772 + schema: &786 title: Exemption response submitted event type: object properties: @@ -113142,12 +113184,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 - exemption_response: *767 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 + exemption_response: *781 sender: *4 required: - action @@ -113220,7 +113262,7 @@ x-webhooks: required: true content: application/json: - schema: *768 + schema: *782 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113287,7 +113329,7 @@ x-webhooks: required: true content: application/json: - schema: *769 + schema: *783 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113354,7 +113396,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113421,7 +113463,7 @@ x-webhooks: required: true content: application/json: - schema: *771 + schema: *785 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113489,7 +113531,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113567,7 +113609,7 @@ x-webhooks: type: string enum: - completed - check_run: &774 + check_run: &788 title: CheckRun description: A check performed on the code of a given code change type: object @@ -113668,7 +113710,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *773 + deployment: *787 details_url: example: https://example.com type: string @@ -113753,9 +113795,9 @@ x-webhooks: - output - app - pull_requests - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -114148,10 +114190,10 @@ x-webhooks: type: string enum: - created - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -114547,10 +114589,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 requested_action: description: The action requested by the user. type: object @@ -114955,10 +114997,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -115935,10 +115977,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -116608,10 +116650,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -117275,10 +117317,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -117586,20 +117628,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &775 + commit_oid: &789 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *761 - installation: *762 - organization: *763 - ref: &776 + enterprise: *775 + installation: *776 + organization: *777 + ref: &790 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -117991,12 +118033,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118259,12 +118301,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118593,12 +118635,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118863,16 +118905,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *764 + repository: *778 sender: *4 required: - action @@ -119106,12 +119148,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -119368,10 +119410,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -119451,18 +119493,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *763 - pusher_type: &777 + organization: *777 + pusher_type: &791 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &778 + ref: &792 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -119472,7 +119514,7 @@ x-webhooks: enum: - tag - branch - repository: *764 + repository: *778 sender: *4 required: - ref @@ -119555,9 +119597,9 @@ x-webhooks: enum: - created definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119642,9 +119684,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119722,9 +119764,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119802,9 +119844,9 @@ x-webhooks: enum: - updated definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119881,10 +119923,10 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - repository: *764 - organization: *763 + enterprise: *775 + installation: *776 + repository: *778 + organization: *777 sender: *4 new_property_values: type: array @@ -119969,18 +120011,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - pusher_type: *777 - ref: *778 + enterprise: *775 + installation: *776 + organization: *777 + pusher_type: *791 + ref: *792 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *764 + repository: *778 sender: *4 required: - ref @@ -120065,10 +120107,10 @@ x-webhooks: enum: - auto_dismissed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120153,10 +120195,10 @@ x-webhooks: enum: - auto_reopened alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120241,10 +120283,10 @@ x-webhooks: enum: - created alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120327,10 +120369,10 @@ x-webhooks: enum: - dismissed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120413,10 +120455,10 @@ x-webhooks: enum: - fixed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120500,10 +120542,10 @@ x-webhooks: enum: - reintroduced alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120586,10 +120628,10 @@ x-webhooks: enum: - reopened alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120666,9 +120708,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - key: &779 + enterprise: *775 + installation: *776 + key: &793 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -120704,8 +120746,8 @@ x-webhooks: - verified - created_at - read_only - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -120782,11 +120824,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - key: *779 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + key: *793 + organization: *777 + repository: *778 sender: *4 required: - action @@ -121347,12 +121389,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: &783 + workflow: &797 title: Workflow type: object nullable: true @@ -122082,9 +122124,9 @@ x-webhooks: pull_requests: type: array items: *615 - repository: *764 - organization: *763 - installation: *762 + repository: *778 + organization: *777 + installation: *776 sender: *4 responses: '200': @@ -122155,7 +122197,7 @@ x-webhooks: type: string enum: - approved - approver: &780 + approver: &794 type: object properties: avatar_url: @@ -122198,11 +122240,11 @@ x-webhooks: type: string comment: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - reviewers: &781 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + reviewers: &795 type: array items: type: object @@ -122281,7 +122323,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &782 + workflow_job_run: &796 type: object properties: conclusion: @@ -123012,18 +123054,18 @@ x-webhooks: type: string enum: - rejected - approver: *780 + approver: *794 comment: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - reviewers: *781 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + reviewers: *795 sender: *4 since: type: string - workflow_job_run: *782 + workflow_job_run: *796 workflow_job_runs: type: array items: @@ -123727,13 +123769,13 @@ x-webhooks: type: string enum: - requested - enterprise: *761 + enterprise: *775 environment: type: string - installation: *762 - organization: *763 - repository: *764 - requestor: &788 + installation: *776 + organization: *777 + repository: *778 + requestor: &802 title: User type: object nullable: true @@ -125632,12 +125674,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Deployment Workflow Run type: object @@ -126317,7 +126359,7 @@ x-webhooks: type: string enum: - answered - answer: &786 + answer: &800 type: object properties: author_association: @@ -126474,7 +126516,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &784 + discussion: &798 title: Discussion description: A Discussion in a repository. type: object @@ -126782,10 +126824,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -126912,11 +126954,11 @@ x-webhooks: - from required: - category - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -126999,11 +127041,11 @@ x-webhooks: type: string enum: - closed - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127085,7 +127127,7 @@ x-webhooks: type: string enum: - created - comment: &785 + comment: &799 type: object properties: author_association: @@ -127242,11 +127284,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127329,12 +127371,12 @@ x-webhooks: type: string enum: - deleted - comment: *785 - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + comment: *799 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127429,12 +127471,12 @@ x-webhooks: - from required: - body - comment: *785 - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + comment: *799 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127518,11 +127560,11 @@ x-webhooks: type: string enum: - created - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127604,11 +127646,11 @@ x-webhooks: type: string enum: - deleted - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127708,11 +127750,11 @@ x-webhooks: type: string required: - from - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127794,10 +127836,10 @@ x-webhooks: type: string enum: - labeled - discussion: *784 - enterprise: *761 - installation: *762 - label: &787 + discussion: *798 + enterprise: *775 + installation: *776 + label: &801 title: Label type: object properties: @@ -127829,8 +127871,8 @@ x-webhooks: - color - default - description - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127913,11 +127955,11 @@ x-webhooks: type: string enum: - locked - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127999,11 +128041,11 @@ x-webhooks: type: string enum: - pinned - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128085,11 +128127,11 @@ x-webhooks: type: string enum: - reopened - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128174,16 +128216,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *784 - new_repository: *764 + new_discussion: *798 + new_repository: *778 required: - new_discussion - new_repository - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128266,10 +128308,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *784 - old_answer: *786 - organization: *763 - repository: *764 + discussion: *798 + old_answer: *800 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128351,12 +128393,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *784 - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128439,11 +128481,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128525,11 +128567,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128601,7 +128643,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128667,7 +128709,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128733,7 +128775,7 @@ x-webhooks: required: true content: application/json: - schema: *768 + schema: *782 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128799,7 +128841,7 @@ x-webhooks: required: true content: application/json: - schema: *769 + schema: *783 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128865,7 +128907,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128931,7 +128973,7 @@ x-webhooks: required: true content: application/json: - schema: *771 + schema: *785 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128997,7 +129039,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -129064,7 +129106,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *761 + enterprise: *775 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -129724,9 +129766,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - forkee @@ -129872,9 +129914,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pages: description: The pages that were updated. type: array @@ -129911,7 +129953,7 @@ x-webhooks: - action - sha - html_url - repository: *764 + repository: *778 sender: *4 required: - pages @@ -129987,10 +130029,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: &789 + organization: *777 + repositories: &803 description: An array of repository objects that the installation can access. type: array @@ -130016,8 +130058,8 @@ x-webhooks: - name - full_name - private - repository: *764 - requester: *788 + repository: *778 + requester: *802 sender: *4 required: - action @@ -130092,11 +130134,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130172,11 +130214,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130252,10 +130294,10 @@ x-webhooks: type: string enum: - added - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories_added: &790 + organization: *777 + repositories_added: &804 description: An array of repository objects, which were added to the installation. type: array @@ -130301,15 +130343,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *764 - repository_selection: &791 + repository: *778 + repository_selection: &805 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *788 + requester: *802 sender: *4 required: - action @@ -130388,10 +130430,10 @@ x-webhooks: type: string enum: - removed - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories_added: *790 + organization: *777 + repositories_added: *804 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130418,9 +130460,9 @@ x-webhooks: - name - full_name - private - repository: *764 - repository_selection: *791 - requester: *788 + repository: *778 + repository_selection: *805 + requester: *802 sender: *4 required: - action @@ -130499,11 +130541,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130682,10 +130724,10 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 target_type: type: string @@ -130764,11 +130806,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -131020,8 +131062,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -132177,8 +132219,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -132258,7 +132300,7 @@ x-webhooks: type: string enum: - deleted - comment: &792 + comment: &806 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -132423,8 +132465,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -133578,8 +133620,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -133659,7 +133701,7 @@ x-webhooks: type: string enum: - edited - changes: &820 + changes: &834 description: The changes to the comment. type: object properties: @@ -133671,9 +133713,9 @@ x-webhooks: type: string required: - from - comment: *792 - enterprise: *761 - installation: *762 + comment: *806 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -134828,8 +134870,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -134911,10 +134953,10 @@ x-webhooks: type: string enum: - assigned - assignee: *788 - enterprise: *761 - installation: *762 - issue: &795 + assignee: *802 + enterprise: *775 + installation: *776 + issue: &809 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -135833,8 +135875,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -135914,8 +135956,8 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -136974,8 +137016,8 @@ x-webhooks: required: - state - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -137054,8 +137096,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137969,8 +138011,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -138049,8 +138091,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138965,7 +139007,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &793 + milestone: &807 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139103,8 +139145,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -139203,8 +139245,8 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140123,9 +140165,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *787 - organization: *763 - repository: *764 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -140205,8 +140247,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141124,9 +141166,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *787 - organization: *763 - repository: *764 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -141206,8 +141248,8 @@ x-webhooks: type: string enum: - locked - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142126,8 +142168,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -142206,8 +142248,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143120,9 +143162,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *793 - organization: *763 - repository: *764 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -144565,8 +144607,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145484,8 +145526,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -145565,9 +145607,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *761 - installation: *762 - issue: &794 + enterprise: *775 + installation: *776 + issue: &808 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146479,8 +146521,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -146559,8 +146601,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147478,8 +147520,8 @@ x-webhooks: user_view_type: type: string type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -148942,11 +148984,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *761 - installation: *762 - issue: *794 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *808 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149026,12 +149068,12 @@ x-webhooks: type: string enum: - typed - enterprise: *761 - installation: *762 - issue: *795 + enterprise: *775 + installation: *776 + issue: *809 type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149112,7 +149154,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &823 + assignee: &837 title: User type: object nullable: true @@ -149182,11 +149224,11 @@ x-webhooks: required: - login - id - enterprise: *761 - installation: *762 - issue: *795 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *809 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149265,12 +149307,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *761 - installation: *762 - issue: *795 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *809 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149350,8 +149392,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150268,8 +150310,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150349,11 +150391,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *761 - installation: *762 - issue: *794 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *808 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150432,12 +150474,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *761 - installation: *762 - issue: *795 + enterprise: *775 + installation: *776 + issue: *809 type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150517,11 +150559,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150599,11 +150641,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150713,11 +150755,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150799,9 +150841,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: &796 + enterprise: *775 + installation: *776 + marketplace_purchase: &810 title: Marketplace Purchase type: object required: @@ -150884,8 +150926,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *763 - previous_marketplace_purchase: &797 + organization: *777 + previous_marketplace_purchase: &811 title: Marketplace Purchase type: object properties: @@ -150965,7 +151007,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151045,10 +151087,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151131,7 +151173,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151213,10 +151255,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151298,7 +151340,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151379,8 +151421,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 marketplace_purchase: title: Marketplace Purchase type: object @@ -151462,9 +151504,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *763 - previous_marketplace_purchase: *797 - repository: *764 + organization: *777 + previous_marketplace_purchase: *811 + repository: *778 sender: *4 required: - action @@ -151544,12 +151586,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 - previous_marketplace_purchase: *797 - repository: *764 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 + previous_marketplace_purchase: *811 + repository: *778 sender: *4 required: - action @@ -151651,11 +151693,11 @@ x-webhooks: type: string required: - to - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151755,11 +151797,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151838,11 +151880,11 @@ x-webhooks: type: string enum: - removed - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151920,11 +151962,11 @@ x-webhooks: type: string enum: - added - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152000,7 +152042,7 @@ x-webhooks: required: - login - id - team: &798 + team: &812 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -152190,11 +152232,11 @@ x-webhooks: type: string enum: - removed - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152271,7 +152313,7 @@ x-webhooks: required: - login - id - team: *798 + team: *812 required: - action - scope @@ -152353,8 +152395,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *762 - merge_group: &800 + installation: *776 + merge_group: &814 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -152373,15 +152415,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *799 + head_commit: *813 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152467,10 +152509,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *762 - merge_group: *800 - organization: *763 - repository: *764 + installation: *776 + merge_group: *814 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152543,7 +152585,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 + enterprise: *775 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -152651,16 +152693,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *762 - organization: *763 + installation: *776 + organization: *777 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -152741,11 +152783,11 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152824,9 +152866,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - milestone: &803 + enterprise: *775 + installation: *776 + milestone: &817 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152963,8 +153005,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153043,11 +153085,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153157,11 +153199,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153241,11 +153283,11 @@ x-webhooks: type: string enum: - opened - enterprise: *761 - installation: *762 - milestone: *803 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *817 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153324,11 +153366,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *788 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + blocked_user: *802 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153407,11 +153449,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *788 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + blocked_user: *802 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153490,9 +153532,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - membership: &804 + enterprise: *775 + installation: *776 + membership: &818 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -153584,8 +153626,8 @@ x-webhooks: - role - organization_url - user - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153663,11 +153705,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153746,8 +153788,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -153863,10 +153905,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 - user: *788 + user: *802 required: - action - invitation @@ -153944,11 +153986,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -154035,11 +154077,11 @@ x-webhooks: properties: from: type: string - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -154115,9 +154157,9 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 package: description: Information about the package. type: object @@ -154616,7 +154658,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &805 + items: &819 title: Ruby Gems metadata type: object properties: @@ -154711,7 +154753,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -154787,9 +154829,9 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 package: description: Information about the package. type: object @@ -155142,7 +155184,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *805 + items: *819 source_url: type: string format: uri @@ -155212,7 +155254,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -155389,12 +155431,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *761 + enterprise: *775 id: type: integer - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - id @@ -155471,7 +155513,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &806 + personal_access_token_request: &820 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -155617,10 +155659,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *761 - organization: *763 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155697,11 +155739,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *806 - enterprise: *761 - organization: *763 + personal_access_token_request: *820 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155777,11 +155819,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *806 - enterprise: *761 - organization: *763 + personal_access_token_request: *820 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155856,11 +155898,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *806 - organization: *763 - enterprise: *761 + personal_access_token_request: *820 + organization: *777 + enterprise: *775 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155965,7 +156007,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *807 + last_response: *821 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -155997,8 +156039,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 zen: description: Random string of GitHub zen. @@ -156243,10 +156285,10 @@ x-webhooks: - from required: - note - enterprise: *761 - installation: *762 - organization: *763 - project_card: &808 + enterprise: *775 + installation: *776 + organization: *777 + project_card: &822 title: Project Card type: object properties: @@ -156365,7 +156407,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -156446,11 +156488,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project_card: *808 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_card: *822 + repository: *778 sender: *4 required: - action @@ -156530,9 +156572,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 project_card: title: Project Card type: object @@ -156660,8 +156702,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -156755,11 +156797,11 @@ x-webhooks: - from required: - note - enterprise: *761 - installation: *762 - organization: *763 - project_card: *808 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_card: *822 + repository: *778 sender: *4 required: - action @@ -156853,9 +156895,9 @@ x-webhooks: - from required: - column_id - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 project_card: allOf: - title: Project Card @@ -157045,7 +157087,7 @@ x-webhooks: type: string required: - after_id - repository: *764 + repository: *778 sender: *4 required: - action @@ -157125,10 +157167,10 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - organization: *763 - project: &810 + enterprise: *775 + installation: *776 + organization: *777 + project: &824 title: Project type: object properties: @@ -157252,7 +157294,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -157332,10 +157374,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project_column: &809 + enterprise: *775 + installation: *776 + organization: *777 + project_column: &823 title: Project Column type: object properties: @@ -157374,7 +157416,7 @@ x-webhooks: - name - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -157453,18 +157495,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -157554,11 +157596,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 + repository: *778 sender: *4 required: - action @@ -157638,11 +157680,11 @@ x-webhooks: type: string enum: - moved - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 + repository: *778 sender: *4 required: - action @@ -157722,11 +157764,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -157806,18 +157848,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - project: *810 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -157919,11 +157961,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -158002,11 +158044,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -158087,9 +158129,9 @@ x-webhooks: type: string enum: - closed - installation: *762 - organization: *763 - projects_v2: &811 + installation: *776 + organization: *777 + projects_v2: &825 title: Projects v2 Project description: A projects v2 project type: object @@ -158232,9 +158274,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158315,9 +158357,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158434,9 +158476,9 @@ x-webhooks: type: string to: type: string - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158519,7 +158561,7 @@ x-webhooks: type: string enum: - archived - changes: &815 + changes: &829 type: object properties: archived_at: @@ -158533,9 +158575,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *762 - organization: *763 - projects_v2_item: &812 + installation: *776 + organization: *777 + projects_v2_item: &826 title: Projects v2 Item description: An item belonging to a project type: object @@ -158669,9 +158711,9 @@ x-webhooks: nullable: true to: type: string - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158753,9 +158795,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158836,9 +158878,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158944,7 +158986,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &813 + - &827 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -158962,7 +159004,7 @@ x-webhooks: required: - id - name - - &814 + - &828 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -158985,8 +159027,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *813 - - *814 + - *827 + - *828 required: - field_value - type: object @@ -159002,9 +159044,9 @@ x-webhooks: nullable: true required: - body - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159099,9 +159141,9 @@ x-webhooks: to: type: string nullable: true - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159184,10 +159226,10 @@ x-webhooks: type: string enum: - restored - changes: *815 - installation: *762 - organization: *763 - projects_v2_item: *812 + changes: *829 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159269,9 +159311,9 @@ x-webhooks: type: string enum: - reopened - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -159352,9 +159394,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2_status_update: &816 + installation: *776 + organization: *777 + projects_v2_status_update: &830 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -159481,9 +159523,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2_status_update: *816 + installation: *776 + organization: *777 + projects_v2_status_update: *830 sender: *4 required: - action @@ -159619,9 +159661,9 @@ x-webhooks: type: string format: date nullable: true - installation: *762 - organization: *763 - projects_v2_status_update: *816 + installation: *776 + organization: *777 + projects_v2_status_update: *830 sender: *4 required: - action @@ -159692,10 +159734,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - repository @@ -159772,13 +159814,13 @@ x-webhooks: type: string enum: - assigned - assignee: *788 - enterprise: *761 - installation: *762 - number: &817 + assignee: *802 + enterprise: *775 + installation: *776 + number: &831 description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -162061,7 +162103,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -162143,11 +162185,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -164425,7 +164467,7 @@ x-webhooks: - draft reason: type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -164507,11 +164549,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -166789,7 +166831,7 @@ x-webhooks: - draft reason: type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -166871,11 +166913,11 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: &818 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: &832 allOf: - *615 - type: object @@ -166939,7 +166981,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *764 + repository: *778 sender: *4 required: - action @@ -167020,12 +167062,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -167105,11 +167147,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *761 + enterprise: *775 milestone: *598 - number: *817 - organization: *763 - pull_request: &819 + number: *831 + organization: *777 + pull_request: &833 title: Pull Request type: object properties: @@ -169372,7 +169414,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -169451,11 +169493,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -171737,7 +171779,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *764 + repository: *778 sender: *4 required: - action @@ -171861,12 +171903,12 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -171946,11 +171988,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -174217,7 +174259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -174297,11 +174339,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *761 - installation: *762 - label: *787 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + label: *801 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -176583,7 +176625,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -176664,10 +176706,10 @@ x-webhooks: type: string enum: - locked - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -178947,7 +178989,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -179027,12 +179069,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *761 + enterprise: *775 milestone: *598 - number: *817 - organization: *763 - pull_request: *819 - repository: *764 + number: *831 + organization: *777 + pull_request: *833 + repository: *778 sender: *4 required: - action @@ -179111,12 +179153,12 @@ x-webhooks: type: string enum: - opened - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179197,12 +179239,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179282,12 +179324,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179653,9 +179695,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -181825,7 +181867,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -181905,7 +181947,7 @@ x-webhooks: type: string enum: - deleted - comment: &821 + comment: &835 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -182190,9 +182232,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -184350,7 +184392,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -184430,11 +184472,11 @@ x-webhooks: type: string enum: - edited - changes: *820 - comment: *821 - enterprise: *761 - installation: *762 - organization: *763 + changes: *834 + comment: *835 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -186595,7 +186637,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -186676,9 +186718,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -188851,7 +188893,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 review: description: The review that was affected. type: object @@ -189094,9 +189136,9 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -191150,8 +191192,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 - review: &822 + repository: *778 + review: &836 description: The review that was affected. type: object properties: @@ -191380,12 +191422,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -193668,7 +193710,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_reviewer: title: User type: object @@ -193752,12 +193794,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -196047,7 +196089,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_team: title: Team description: Groups of organization members that gives permissions @@ -196239,12 +196281,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -198529,7 +198571,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_reviewer: title: User type: object @@ -198614,12 +198656,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -200895,7 +200937,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201076,9 +201118,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -203253,8 +203295,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 - review: *822 + repository: *778 + review: *836 sender: *4 required: - action @@ -203334,9 +203376,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -205406,7 +205448,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 sender: *4 thread: type: object @@ -205789,9 +205831,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -207847,7 +207889,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 sender: *4 thread: type: object @@ -208233,10 +208275,10 @@ x-webhooks: type: string before: type: string - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -210507,7 +210549,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -210589,11 +210631,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *823 - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + assignee: *837 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -212876,7 +212918,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -212955,11 +212997,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *761 - installation: *762 - label: *787 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + label: *801 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -215232,7 +215274,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -215313,10 +215355,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -217581,7 +217623,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -217781,7 +217823,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *761 + enterprise: *775 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -217873,8 +217915,8 @@ x-webhooks: - url - author - committer - installation: *762 - organization: *763 + installation: *776 + organization: *777 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -218449,9 +218491,9 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 registry_package: type: object properties: @@ -218897,7 +218939,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *805 + items: *819 summary: type: string tag_name: @@ -218951,7 +218993,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -219029,9 +219071,9 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 registry_package: type: object properties: @@ -219339,7 +219381,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *805 + items: *819 summary: type: string tag_name: @@ -219388,7 +219430,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -219465,10 +219507,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - release: &824 + enterprise: *775 + installation: *776 + organization: *777 + release: &838 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -219777,7 +219819,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *764 + repository: *778 sender: *4 required: - action @@ -219854,11 +219896,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -219975,11 +220017,11 @@ x-webhooks: type: boolean required: - to - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -220057,9 +220099,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -220372,7 +220414,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *764 + repository: *778 sender: *4 required: - action @@ -220448,10 +220490,10 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - release: &825 + enterprise: *775 + installation: *776 + organization: *777 + release: &839 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -220761,7 +220803,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *764 + repository: *778 sender: *4 required: - action @@ -220837,11 +220879,11 @@ x-webhooks: type: string enum: - released - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -220917,11 +220959,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *761 - installation: *762 - organization: *763 - release: *825 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *839 + repository: *778 sender: *4 required: - action @@ -220997,11 +221039,11 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - repository_advisory: *672 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + repository_advisory: *686 sender: *4 required: - action @@ -221077,11 +221119,11 @@ x-webhooks: type: string enum: - reported - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - repository_advisory: *672 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + repository_advisory: *686 sender: *4 required: - action @@ -221157,10 +221199,10 @@ x-webhooks: type: string enum: - archived - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221237,10 +221279,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221318,10 +221360,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221405,10 +221447,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221520,10 +221562,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221595,10 +221637,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 status: type: string @@ -221679,10 +221721,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221759,10 +221801,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221856,10 +221898,10 @@ x-webhooks: - name required: - repository - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221939,10 +221981,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 sender: *4 required: @@ -222021,10 +222063,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 sender: *4 required: @@ -222103,10 +222145,10 @@ x-webhooks: type: string enum: - edited - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 changes: type: object @@ -222411,10 +222453,10 @@ x-webhooks: - from required: - owner - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222492,10 +222534,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222573,7 +222615,7 @@ x-webhooks: type: string enum: - create - alert: &826 + alert: &840 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -222694,10 +222736,10 @@ x-webhooks: type: string enum: - open - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222903,10 +222945,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222984,11 +223026,11 @@ x-webhooks: type: string enum: - reopen - alert: *826 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *840 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223187,10 +223229,10 @@ x-webhooks: enum: - fixed - open - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223268,7 +223310,7 @@ x-webhooks: type: string enum: - created - alert: &827 + alert: &841 type: object properties: number: *100 @@ -223379,10 +223421,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223463,11 +223505,11 @@ x-webhooks: type: string enum: - created - alert: *827 - installation: *762 - location: *828 - organization: *763 - repository: *764 + alert: *841 + installation: *776 + location: *842 + organization: *777 + repository: *778 sender: *4 required: - location @@ -223705,11 +223747,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223787,11 +223829,11 @@ x-webhooks: type: string enum: - reopened - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223869,11 +223911,11 @@ x-webhooks: type: string enum: - resolved - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223951,11 +223993,11 @@ x-webhooks: type: string enum: - validated - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -224081,10 +224123,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *764 - enterprise: *761 - installation: *762 - organization: *763 + repository: *778 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -224162,11 +224204,11 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - security_advisory: &829 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + security_advisory: &843 description: The details of the security advisory, including summary, description, and severity. type: object @@ -224349,11 +224391,11 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - security_advisory: *829 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + security_advisory: *843 sender: *4 required: - action @@ -224426,10 +224468,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -224614,9 +224656,9 @@ x-webhooks: type: object properties: security_and_analysis: *328 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: *392 sender: *4 required: @@ -224695,12 +224737,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: &830 + sponsorship: &844 type: object properties: created_at: @@ -225001,12 +225043,12 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - sponsorship @@ -225094,12 +225136,12 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225176,17 +225218,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &831 + effective_date: &845 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - sponsorship @@ -225260,7 +225302,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &832 + changes: &846 type: object properties: tier: @@ -225304,13 +225346,13 @@ x-webhooks: - from required: - tier - effective_date: *831 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + effective_date: *845 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225387,13 +225429,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *832 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + changes: *846 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225467,10 +225509,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225553,10 +225595,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225976,15 +226018,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *761 + enterprise: *775 id: description: The unique identifier of the status. type: integer - installation: *762 + installation: *776 name: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 sha: description: The Commit SHA. @@ -226099,9 +226141,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226191,9 +226233,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226283,9 +226325,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226375,9 +226417,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226454,12 +226496,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - team: &833 + team: &847 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -226649,9 +226691,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -227109,7 +227151,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -227185,9 +227227,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -227645,7 +227687,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -227722,9 +227764,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -228182,7 +228224,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -228326,9 +228368,9 @@ x-webhooks: - from required: - permissions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -228786,7 +228828,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - changes @@ -228864,9 +228906,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -229324,7 +229366,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -229400,10 +229442,10 @@ x-webhooks: type: string enum: - started - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -229476,16 +229518,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *761 + enterprise: *775 inputs: type: object nullable: true additionalProperties: true - installation: *762 - organization: *763 + installation: *776 + organization: *777 ref: type: string - repository: *764 + repository: *778 sender: *4 workflow: type: string @@ -229567,10 +229609,10 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: allOf: @@ -229886,10 +229928,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: allOf: @@ -230228,10 +230270,10 @@ x-webhooks: type: string enum: - queued - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: type: object @@ -230445,10 +230487,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: type: object @@ -230664,12 +230706,12 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object @@ -231668,12 +231710,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object @@ -232657,12 +232699,12 @@ x-webhooks: type: string enum: - requested - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index bb8e48f938..cba86773f3 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -46921,6 +46921,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -170551,6 +170836,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -458042,6 +458612,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } } @@ -458758,6 +459613,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, @@ -459427,6 +460567,291 @@ "type": "boolean", "description": "A boolean value representing whether or not alert is base64 encoded", "nullable": true + }, + "first_location_detected": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ], + "nullable": true } } }, diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index f3dbc28b41..e1603eea30 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -1025,7 +1025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &674 + - &688 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1709,7 +1709,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &684 + schema: &698 title: Scim Error description: Scim Error type: object @@ -17737,6 +17737,275 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: &668 + - &670 + description: Represents a 'commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8BIT + ASCII + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit + resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - &671 + description: Represents a 'wiki_commit' secret scanning location + type. This location type shows that a secret was detected + inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in + the file + end_line: + type: number + description: Line number at which the secret ends in the + file + start_column: + type: number + description: The column at which the secret starts within + the start line when the file is interpreted as 8-bit + ASCII. + end_column: + type: number + description: The column at which the secret ends within + the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki + page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki + commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + - &672 + description: Represents an 'issue_title' secret scanning location + type. This location type shows that a secret was detected + in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + - &673 + description: Represents an 'issue_body' secret scanning location + type. This location type shows that a secret was detected + in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + - &674 + description: Represents an 'issue_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + - &675 + description: Represents a 'discussion_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + - &676 + description: Represents a 'discussion_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + - &677 + description: Represents a 'discussion_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment + where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + - &678 + description: Represents a 'pull_request_title' secret scanning + location type. This location type shows that a secret was + detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + - &679 + description: Represents a 'pull_request_body' secret scanning + location type. This location type shows that a secret was + detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where + the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + - &680 + description: Represents a 'pull_request_comment' secret scanning + location type. This location type shows that a secret was + detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + - &681 + description: Represents a 'pull_request_review' secret scanning + location type. This location type shows that a secret was + detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review + where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + - &682 + description: Represents a 'pull_request_review_comment' secret + scanning location type. This location type shows that a + secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review + comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable: true examples: default: &344 value: @@ -19835,7 +20104,7 @@ paths: url: type: string format: uri - user: &723 + user: &737 title: Public User description: Public User type: object @@ -24276,7 +24545,7 @@ paths: type: array items: *59 examples: - default: &741 + default: &755 value: - login: github id: 1 @@ -26098,7 +26367,7 @@ paths: type: array items: *64 examples: - default: &735 + default: &749 value: total_count: 1 repositories: @@ -26917,7 +27186,7 @@ paths: type: array items: *198 examples: - default: &726 + default: &740 value: total_count: 1 repositories: @@ -38451,7 +38720,7 @@ paths: parameters: - *172 - *301 - - &740 + - &754 name: repo_name description: repo_name parameter in: path @@ -39766,7 +40035,7 @@ paths: - nuget - container - *172 - - &742 + - &756 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -39807,7 +40076,7 @@ paths: default: *308 '403': *29 '401': *25 - '400': &744 + '400': &758 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -44321,7 +44590,7 @@ paths: application/json: schema: type: array - items: &672 + items: &686 description: A repository security advisory. type: object properties: @@ -44612,7 +44881,7 @@ paths: - private_fork additionalProperties: false examples: - default: &673 + default: &687 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -46375,7 +46644,7 @@ paths: - updated_at - url examples: - default: &713 + default: &727 value: - author: login: octocat @@ -46623,7 +46892,7 @@ paths: application/json: schema: *362 examples: - default: &714 + default: &728 value: author: login: octocat @@ -46806,7 +47075,7 @@ paths: - updated_at - url examples: - default: &715 + default: &729 value: - author: login: octocat @@ -47032,7 +47301,7 @@ paths: application/json: schema: *365 examples: - default: &716 + default: &730 value: author: login: octocat @@ -47745,7 +48014,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &717 + response-if-user-is-a-team-maintainer: &731 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47810,7 +48079,7 @@ paths: application/json: schema: *376 examples: - response-if-users-membership-with-team-is-now-pending: &718 + response-if-users-membership-with-team-is-now-pending: &732 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47951,7 +48220,7 @@ paths: - updated_at - permissions examples: - default: &719 + default: &733 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48030,7 +48299,7 @@ paths: application/json: schema: *377 examples: - default: &720 + default: &734 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -48240,7 +48509,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &721 + schema: &735 title: Team Repository description: A team's access to a repository. type: object @@ -49006,7 +49275,7 @@ paths: type: array items: *229 examples: - response-if-child-teams-exist: &722 + response-if-child-teams-exist: &736 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -61187,7 +61456,7 @@ paths: check. type: array items: *451 - deployment: &773 + deployment: &787 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -62099,7 +62368,7 @@ paths: type: string format: date-time nullable: true - head_commit: &799 + head_commit: &813 title: Simple Commit description: A commit. type: object @@ -66319,14 +66588,14 @@ paths: type: integer machines: type: array - items: &729 + items: &743 type: object title: Codespace machine description: A description of the machine powering a codespace. properties: *490 required: *491 examples: - default: &730 + default: &744 value: total_count: 2 machines: @@ -69626,7 +69895,7 @@ paths: application/json: schema: type: array - items: &677 + items: &691 title: Status description: The status of a commit. type: object @@ -71182,7 +71451,7 @@ paths: items: type: object properties: - placeholder_id: &669 + placeholder_id: &683 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -77120,7 +77389,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &807 + last_response: &821 title: Hook Response type: object properties: @@ -78080,7 +78349,7 @@ paths: parameters: - *379 - *380 - - &753 + - &767 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -78514,7 +78783,7 @@ paths: type: array items: *568 examples: - default: &746 + default: &760 value: - id: 1 repository: @@ -92256,7 +92525,7 @@ paths: application/json: schema: type: array - items: &668 + items: &669 type: object properties: number: *100 @@ -92366,6 +92635,14 @@ paths: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + description: 'Details on the location where the token was initially + detected. This can be a commit, wiki commit, issue, discussion, + pull request. + + ' + oneOf: *668 + nullable: true examples: default: value: @@ -92503,7 +92780,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -92584,7 +92861,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *669 examples: default: value: @@ -92672,7 +92949,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &828 + items: &842 type: object properties: type: @@ -92698,254 +92975,19 @@ paths: example: commit details: oneOf: - - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url + - *670 + - *671 + - *672 + - *673 + - *674 + - *675 + - *676 + - *677 + - *678 + - *679 + - *680 + - *681 + - *682 examples: default: value: @@ -93040,14 +93082,14 @@ paths: schema: type: object properties: - reason: &670 + reason: &684 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *669 + placeholder_id: *683 required: - reason - placeholder_id @@ -93064,7 +93106,7 @@ paths: schema: type: object properties: - reason: *670 + reason: *684 expire_at: type: string format: date-time @@ -93123,7 +93165,7 @@ paths: properties: incremental_scans: type: array - items: &671 + items: &685 description: Information on a single scan performed by secret scanning on the repository type: object @@ -93149,15 +93191,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *671 + items: *685 backfill_scans: type: array - items: *671 + items: *685 custom_pattern_backfill_scans: type: array items: allOf: - - *671 + - *685 - type: object properties: pattern_name: @@ -93272,9 +93314,9 @@ paths: application/json: schema: type: array - items: *672 + items: *686 examples: - default: *673 + default: *687 '400': *14 '404': *6 x-github: @@ -93458,9 +93500,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: &675 + default: &689 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -93798,7 +93840,7 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: default: value: @@ -93947,15 +93989,15 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '200': description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: *675 + default: *689 '403': *29 '404': *6 x-github: @@ -93981,7 +94023,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 requestBody: required: true content: @@ -94140,10 +94182,10 @@ paths: description: Response content: application/json: - schema: *672 + schema: *686 examples: - default: *675 - add_credit: *675 + default: *689 + add_credit: *689 '403': *29 '404': *6 '422': @@ -94183,7 +94225,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '202': *39 '400': *14 @@ -94212,7 +94254,7 @@ paths: parameters: - *379 - *380 - - *674 + - *688 responses: '202': description: Response @@ -94356,7 +94398,7 @@ paths: application/json: schema: type: array - items: &676 + items: &690 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -94729,7 +94771,7 @@ paths: application/json: schema: type: array - items: *676 + items: *690 examples: default: value: @@ -94817,7 +94859,7 @@ paths: description: Response content: application/json: - schema: *677 + schema: *691 examples: default: value: @@ -94911,7 +94953,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &678 + schema: &692 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -95006,7 +95048,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *692 examples: default: value: @@ -95143,7 +95185,7 @@ paths: application/json: schema: type: array - items: &679 + items: &693 title: Tag protection description: Tag protection type: object @@ -95219,7 +95261,7 @@ paths: description: Response content: application/json: - schema: *679 + schema: *693 examples: default: value: @@ -95367,7 +95409,7 @@ paths: description: Response content: application/json: - schema: &680 + schema: &694 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -95379,7 +95421,7 @@ paths: required: - names examples: - default: &681 + default: &695 value: names: - octocat @@ -95434,9 +95476,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *694 examples: - default: *681 + default: *695 '404': *6 '422': *7 x-github: @@ -95459,7 +95501,7 @@ paths: parameters: - *379 - *380 - - &682 + - &696 name: per description: The time frame to display results for. in: query @@ -95488,7 +95530,7 @@ paths: example: 128 clones: type: array - items: &683 + items: &697 title: Traffic type: object properties: @@ -95729,7 +95771,7 @@ paths: parameters: - *379 - *380 - - *682 + - *696 responses: '200': description: Response @@ -95748,7 +95790,7 @@ paths: example: 3782 views: type: array - items: *683 + items: *697 required: - uniques - count @@ -96420,7 +96462,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &691 + - &705 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -96429,7 +96471,7 @@ paths: schema: type: string example: members - - &696 + - &710 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -96440,7 +96482,7 @@ paths: default: 1 format: int32 example: 1 - - &697 + - &711 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -96482,7 +96524,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &685 + items: &699 allOf: - type: object required: @@ -96557,7 +96599,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &698 + meta: &712 type: object description: The metadata associated with the creation/updates to the user. @@ -96617,31 +96659,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &686 + '400': &700 description: Bad request content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '401': &687 + schema: *698 + '401': &701 description: Authorization failure - '403': &688 + '403': &702 description: Permission denied - '429': &689 + '429': &703 description: Too many requests content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '500': &690 + schema: *698 + '500': &704 description: Internal server error content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 + schema: *698 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96665,7 +96707,7 @@ paths: required: true content: application/json: - schema: &694 + schema: &708 type: object required: - schemas @@ -96721,9 +96763,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *685 + schema: *699 examples: - group: &692 + group: &706 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -96742,13 +96784,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *686 - '401': *687 - '403': *688 - '409': &695 + '400': *700 + '401': *701 + '403': *702 + '409': &709 description: Duplicate record detected - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96765,7 +96807,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &693 + - &707 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -96773,22 +96815,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *691 + - *705 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *685 + schema: *699 examples: - default: *692 - '400': *686 - '401': *687 - '403': *688 + default: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96807,13 +96849,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *693 + - *707 - *41 requestBody: required: true content: application/json: - schema: *694 + schema: *708 examples: group: summary: Group @@ -96839,17 +96881,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *685 + schema: *699 examples: - group: *692 - groupWithMembers: *692 - '400': *686 - '401': *687 - '403': *688 + group: *706 + groupWithMembers: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96873,13 +96915,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *693 + - *707 - *41 requestBody: required: true content: application/json: - schema: &705 + schema: &719 type: object required: - Operations @@ -96939,17 +96981,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *685 + schema: *699 examples: - updateGroup: *692 - addMembers: *692 - '400': *686 - '401': *687 - '403': *688 + updateGroup: *706 + addMembers: *706 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -96965,17 +97007,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *693 + - *707 - *41 responses: '204': description: Group was deleted, no content - '400': *686 - '401': *687 - '403': *688 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97009,8 +97051,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *696 - - *697 + - *710 + - *711 - *41 responses: '200': @@ -97043,7 +97085,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &700 + items: &714 allOf: - type: object required: @@ -97122,7 +97164,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &699 + roles: &713 type: array description: The roles assigned to the user. items: @@ -97178,7 +97220,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *698 + meta: *712 startIndex: type: integer description: A starting index for the returned page @@ -97215,11 +97257,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *686 - '401': *687 - '403': *688 - '429': *689 - '500': *690 + '400': *700 + '401': *701 + '403': *702 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97243,7 +97285,7 @@ paths: required: true content: application/json: - schema: &703 + schema: &717 type: object required: - schemas @@ -97325,9 +97367,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *699 + roles: *713 examples: - user: &704 + user: &718 summary: User value: schemas: @@ -97374,9 +97416,9 @@ paths: description: User has been created content: application/scim+json: - schema: *700 + schema: *714 examples: - user: &701 + user: &715 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -97402,13 +97444,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *701 - '400': *686 - '401': *687 - '403': *688 - '409': *695 - '429': *689 - '500': *690 + enterpriseOwner: *715 + '400': *700 + '401': *701 + '403': *702 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97425,7 +97467,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &702 + - &716 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -97438,15 +97480,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *700 + schema: *714 examples: - default: *701 - '400': *686 - '401': *687 - '403': *688 + default: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97468,30 +97510,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *702 + - *716 - *41 requestBody: required: true content: application/json: - schema: *703 + schema: *717 examples: - user: *704 + user: *718 responses: '200': description: User was updated content: application/scim+json: - schema: *700 + schema: *714 examples: - user: *701 - '400': *686 - '401': *687 - '403': *688 + user: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97526,13 +97568,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *702 + - *716 - *41 requestBody: required: true content: application/json: - schema: *705 + schema: *719 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -97572,18 +97614,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *700 - examples: - userMultiValuedProperties: *701 - userSingleValuedProperties: *701 - disableUser: *701 - '400': *686 - '401': *687 - '403': *688 + schema: *714 + examples: + userMultiValuedProperties: *715 + userSingleValuedProperties: *715 + disableUser: *715 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '409': *695 - '429': *689 - '500': *690 + '409': *709 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97603,17 +97645,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *702 + - *716 - *41 responses: '204': description: User was deleted, no content - '400': *686 - '401': *687 - '403': *688 + '400': *700 + '401': *701 + '403': *702 '404': *6 - '429': *689 - '500': *690 + '429': *703 + '500': *704 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -97700,7 +97742,7 @@ paths: example: 1 Resources: type: array - items: &706 + items: &720 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -97931,22 +97973,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &707 + '404': &721 description: Resource not found content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '403': &708 + schema: *698 + '403': &722 description: Forbidden content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '400': *686 - '429': *689 + schema: *698 + '400': *700 + '429': *703 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -97972,9 +98014,9 @@ paths: description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: &709 + default: &723 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -97997,17 +98039,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *707 - '403': *708 - '500': *690 + '404': *721 + '403': *722 + '500': *704 '409': description: Conflict content: application/json: - schema: *684 + schema: *698 application/scim+json: - schema: *684 - '400': *686 + schema: *698 + '400': *700 requestBody: required: true content: @@ -98105,17 +98147,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 - '404': *707 - '403': *708 + default: *723 + '404': *721 + '403': *722 '304': *37 x-github: githubCloudOnly: true @@ -98139,18 +98181,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 + default: *723 '304': *37 - '404': *707 - '403': *708 + '404': *721 + '403': *722 requestBody: required: true content: @@ -98263,19 +98305,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *172 - - *702 + - *716 responses: '200': description: Response content: application/scim+json: - schema: *706 + schema: *720 examples: - default: *709 + default: *723 '304': *37 - '404': *707 - '403': *708 - '400': *686 + '404': *721 + '403': *722 + '400': *700 '429': description: Response content: @@ -98366,12 +98408,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *172 - - *702 + - *716 responses: '204': description: Response - '404': *707 - '403': *708 + '404': *721 + '403': *722 '304': *37 x-github: githubCloudOnly: true @@ -98504,7 +98546,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &710 + text_matches: &724 title: Search Result Text Matches type: array items: @@ -98667,7 +98709,7 @@ paths: enum: - author-date - committer-date - - &711 + - &725 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -98795,7 +98837,7 @@ paths: type: number node_id: type: string - text_matches: *710 + text_matches: *724 required: - sha - node_id @@ -98978,7 +99020,7 @@ paths: - interactions - created - updated - - *711 + - *725 - *17 - *19 - name: advanced_search @@ -99120,7 +99162,7 @@ paths: type: string format: date-time nullable: true - text_matches: *710 + text_matches: *724 pull_request: type: object properties: @@ -99348,7 +99390,7 @@ paths: enum: - created - updated - - *711 + - *725 - *17 - *19 responses: @@ -99392,7 +99434,7 @@ paths: nullable: true score: type: number - text_matches: *710 + text_matches: *724 required: - id - node_id @@ -99478,7 +99520,7 @@ paths: - forks - help-wanted-issues - updated - - *711 + - *725 - *17 - *19 responses: @@ -99717,7 +99759,7 @@ paths: - admin - pull - push - text_matches: *710 + text_matches: *724 temp_clone_token: type: string allow_merge_commit: @@ -100018,7 +100060,7 @@ paths: type: string format: uri nullable: true - text_matches: *710 + text_matches: *724 related: type: array nullable: true @@ -100211,7 +100253,7 @@ paths: - followers - repositories - joined - - *711 + - *725 - *17 - *19 responses: @@ -100315,7 +100357,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *710 + text_matches: *724 blog: type: string nullable: true @@ -100394,7 +100436,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &712 + - &726 name: team_id description: The unique identifier of the team. in: path @@ -100435,7 +100477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -100535,7 +100577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *712 + - *726 responses: '204': description: Response @@ -100566,7 +100608,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *712 + - *726 - *88 - *17 - *19 @@ -100579,7 +100621,7 @@ paths: type: array items: *362 examples: - default: *713 + default: *727 headers: Link: *40 x-github: @@ -100608,7 +100650,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -100671,7 +100713,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *712 + - *726 - *364 responses: '200': @@ -100705,7 +100747,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *712 + - *726 - *364 requestBody: required: false @@ -100731,7 +100773,7 @@ paths: application/json: schema: *362 examples: - default: *714 + default: *728 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100756,7 +100798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *712 + - *726 - *364 responses: '204': @@ -100786,7 +100828,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *712 + - *726 - *364 - *88 - *17 @@ -100800,7 +100842,7 @@ paths: type: array items: *365 examples: - default: *715 + default: *729 headers: Link: *40 x-github: @@ -100829,7 +100871,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 requestBody: required: true @@ -100881,7 +100923,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 responses: @@ -100916,7 +100958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 requestBody: @@ -100942,7 +100984,7 @@ paths: application/json: schema: *365 examples: - default: *716 + default: *730 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -100967,7 +101009,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 responses: @@ -100998,7 +101040,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 - name: content @@ -101057,7 +101099,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *712 + - *726 - *364 - *367 requestBody: @@ -101119,7 +101161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *712 + - *726 - *364 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). @@ -101177,7 +101219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *712 + - *726 - *364 requestBody: required: true @@ -101236,7 +101278,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101274,7 +101316,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *712 + - *726 - name: role description: Filters members returned by their role in the team. in: query @@ -101325,7 +101367,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101362,7 +101404,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101402,7 +101444,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101439,7 +101481,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 responses: '200': @@ -101448,7 +101490,7 @@ paths: application/json: schema: *376 examples: - response-if-user-is-a-team-maintainer: *717 + response-if-user-is-a-team-maintainer: *731 '404': *6 x-github: githubCloudOnly: false @@ -101481,7 +101523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 requestBody: required: false @@ -101509,7 +101551,7 @@ paths: application/json: schema: *376 examples: - response-if-users-membership-with-team-is-now-pending: *718 + response-if-users-membership-with-team-is-now-pending: *732 '403': description: Forbidden if team synchronization is set up '422': @@ -101543,7 +101585,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *712 + - *726 - *220 responses: '204': @@ -101572,7 +101614,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101584,7 +101626,7 @@ paths: type: array items: *377 examples: - default: *719 + default: *733 headers: Link: *40 '404': *6 @@ -101610,7 +101652,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *712 + - *726 - *378 responses: '200': @@ -101619,7 +101661,7 @@ paths: application/json: schema: *377 examples: - default: *720 + default: *734 '404': description: Not Found if project is not managed by this team x-github: @@ -101643,7 +101685,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *712 + - *726 - *378 requestBody: required: false @@ -101711,7 +101753,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *712 + - *726 - *378 responses: '204': @@ -101739,7 +101781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -101781,7 +101823,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *712 + - *726 - *379 - *380 responses: @@ -101789,7 +101831,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *721 + schema: *735 examples: alternative-response-with-extra-repository-information: value: @@ -101940,7 +101982,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *712 + - *726 - *379 - *380 requestBody: @@ -101992,7 +102034,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *712 + - *726 - *379 - *380 responses: @@ -102023,7 +102065,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *712 + - *726 responses: '200': description: Response @@ -102058,7 +102100,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *712 + - *726 requestBody: required: true content: @@ -102146,7 +102188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *712 + - *726 - *17 - *19 responses: @@ -102158,7 +102200,7 @@ paths: type: array items: *229 examples: - response-if-child-teams-exist: *722 + response-if-child-teams-exist: *736 headers: Link: *40 '404': *6 @@ -102191,7 +102233,7 @@ paths: application/json: schema: oneOf: - - &724 + - &738 title: Private User description: Private User type: object @@ -102394,7 +102436,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *723 + - *737 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -102547,7 +102589,7 @@ paths: description: Response content: application/json: - schema: *724 + schema: *738 examples: default: value: @@ -102945,7 +102987,7 @@ paths: type: integer secrets: type: array - items: &725 + items: &739 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -103061,7 +103103,7 @@ paths: description: Response content: application/json: - schema: *725 + schema: *739 examples: default: value: @@ -103207,7 +103249,7 @@ paths: type: array items: *198 examples: - default: *726 + default: *740 '401': *25 '403': *29 '404': *6 @@ -103474,7 +103516,7 @@ paths: description: Response content: application/json: - schema: &727 + schema: &741 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -103515,7 +103557,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &728 + default: &742 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -103560,9 +103602,9 @@ paths: description: Response content: application/json: - schema: *727 + schema: *741 examples: - default: *728 + default: *742 '404': *6 x-github: githubCloudOnly: false @@ -103599,9 +103641,9 @@ paths: type: integer machines: type: array - items: *729 + items: *743 examples: - default: *730 + default: *744 '304': *37 '500': *85 '401': *25 @@ -104540,7 +104582,7 @@ paths: type: array items: *307 examples: - default: &743 + default: &757 value: - id: 197 name: hello_docker @@ -104641,7 +104683,7 @@ paths: application/json: schema: type: array - items: &731 + items: &745 title: Email description: Email type: object @@ -104706,9 +104748,9 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: - default: &745 + default: &759 value: - email: octocat@github.com verified: true @@ -104783,7 +104825,7 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: default: value: @@ -105039,7 +105081,7 @@ paths: application/json: schema: type: array - items: &732 + items: &746 title: GPG Key description: A unique encryption key type: object @@ -105170,7 +105212,7 @@ paths: - subkeys - revoked examples: - default: &756 + default: &770 value: - id: 3 name: Octocat's GPG Key @@ -105255,9 +105297,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *746 examples: - default: &733 + default: &747 value: id: 3 name: Octocat's GPG Key @@ -105314,7 +105356,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &734 + - &748 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -105326,9 +105368,9 @@ paths: description: Response content: application/json: - schema: *732 + schema: *746 examples: - default: *733 + default: *747 '404': *6 '304': *37 '403': *29 @@ -105351,7 +105393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *734 + - *748 responses: '204': description: Response @@ -105542,7 +105584,7 @@ paths: type: array items: *64 examples: - default: *735 + default: *749 headers: Link: *40 '404': *6 @@ -105806,7 +105848,7 @@ paths: application/json: schema: type: array - items: &736 + items: &750 title: Key description: Key type: object @@ -105903,9 +105945,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *750 examples: - default: &737 + default: &751 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105944,9 +105986,9 @@ paths: description: Response content: application/json: - schema: *736 + schema: *750 examples: - default: *737 + default: *751 '404': *6 '304': *37 '403': *29 @@ -106002,7 +106044,7 @@ paths: application/json: schema: type: array - items: &738 + items: &752 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -106070,7 +106112,7 @@ paths: - account - plan examples: - default: &739 + default: &753 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -106132,9 +106174,9 @@ paths: application/json: schema: type: array - items: *738 + items: *752 examples: - default: *739 + default: *753 headers: Link: *40 '304': *37 @@ -107129,7 +107171,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - *301 - - *740 + - *754 responses: '204': description: Response @@ -107202,7 +107244,7 @@ paths: type: array items: *59 examples: - default: *741 + default: *755 headers: Link: *40 '304': *37 @@ -107244,7 +107286,7 @@ paths: - docker - nuget - container - - *742 + - *756 - *19 - *17 responses: @@ -107256,8 +107298,8 @@ paths: type: array items: *307 examples: - default: *743 - '400': *744 + default: *757 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107286,7 +107328,7 @@ paths: application/json: schema: *307 examples: - default: &757 + default: &771 value: id: 40201 name: octo-name @@ -107739,9 +107781,9 @@ paths: application/json: schema: type: array - items: *731 + items: *745 examples: - default: *745 + default: *759 headers: Link: *40 '304': *37 @@ -107854,7 +107896,7 @@ paths: type: array items: *64 examples: - default: &752 + default: &766 summary: Default response value: - id: 1296269 @@ -108200,7 +108242,7 @@ paths: type: array items: *568 examples: - default: *746 + default: *760 headers: Link: *40 '304': *37 @@ -108279,7 +108321,7 @@ paths: application/json: schema: type: array - items: &747 + items: &761 title: Social account description: Social media account type: object @@ -108294,7 +108336,7 @@ paths: - provider - url examples: - default: &748 + default: &762 value: - provider: twitter url: https://twitter.com/github @@ -108356,9 +108398,9 @@ paths: application/json: schema: type: array - items: *747 + items: *761 examples: - default: *748 + default: *762 '422': *15 '304': *37 '404': *6 @@ -108445,7 +108487,7 @@ paths: application/json: schema: type: array - items: &749 + items: &763 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -108465,7 +108507,7 @@ paths: - title - created_at examples: - default: &758 + default: &772 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108531,9 +108573,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *763 examples: - default: &750 + default: &764 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108564,7 +108606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &751 + - &765 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -108576,9 +108618,9 @@ paths: description: Response content: application/json: - schema: *749 + schema: *763 examples: - default: *750 + default: *764 '404': *6 '304': *37 '403': *29 @@ -108601,7 +108643,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *751 + - *765 responses: '204': description: Response @@ -108630,7 +108672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &759 + - &773 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -108655,11 +108697,11 @@ paths: type: array items: *64 examples: - default-response: *752 + default-response: *766 application/vnd.github.v3.star+json: schema: type: array - items: &760 + items: &774 title: Starred Repository description: Starred Repository type: object @@ -109028,10 +109070,10 @@ paths: application/json: schema: oneOf: - - *724 - - *723 + - *738 + - *737 examples: - default-response: &754 + default-response: &768 summary: Default response value: login: octocat @@ -109066,7 +109108,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &755 + response-with-git-hub-plan-information: &769 summary: Response with GitHub plan information value: login: octocat @@ -109126,7 +109168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *753 + - *767 - *17 responses: '200': @@ -109175,11 +109217,11 @@ paths: application/json: schema: oneOf: - - *724 - - *723 + - *738 + - *737 examples: - default-response: *754 - response-with-git-hub-plan-information: *755 + default-response: *768 + response-with-git-hub-plan-information: *769 '404': *6 x-github: githubCloudOnly: false @@ -109296,7 +109338,7 @@ paths: type: array items: *307 examples: - default: *743 + default: *757 '403': *29 '401': *25 x-github: @@ -109700,9 +109742,9 @@ paths: application/json: schema: type: array - items: *732 + items: *746 examples: - default: *756 + default: *770 headers: Link: *40 x-github: @@ -109884,7 +109926,7 @@ paths: type: array items: *59 examples: - default: *741 + default: *755 headers: Link: *40 x-github: @@ -109923,7 +109965,7 @@ paths: - docker - nuget - container - - *742 + - *756 - *220 - *19 - *17 @@ -109936,10 +109978,10 @@ paths: type: array items: *307 examples: - default: *743 + default: *757 '403': *29 '401': *25 - '400': *744 + '400': *758 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109969,7 +110011,7 @@ paths: application/json: schema: *307 examples: - default: *757 + default: *771 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -110753,9 +110795,9 @@ paths: application/json: schema: type: array - items: *747 + items: *761 examples: - default: *748 + default: *762 headers: Link: *40 x-github: @@ -110785,9 +110827,9 @@ paths: application/json: schema: type: array - items: *749 + items: *763 examples: - default: *758 + default: *772 headers: Link: *40 x-github: @@ -110812,7 +110854,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *220 - - *759 + - *773 - *88 - *17 - *19 @@ -110824,11 +110866,11 @@ paths: schema: anyOf: - type: array - items: *760 + items: *774 - type: array items: *64 examples: - default-response: *752 + default-response: *766 headers: Link: *40 x-github: @@ -110987,7 +111029,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &761 + enterprise: &775 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -111045,7 +111087,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &762 + installation: &776 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -111064,7 +111106,7 @@ x-webhooks: required: - id - node_id - organization: &763 + organization: &777 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -111124,13 +111166,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &764 + repository: &778 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &801 + properties: &815 id: description: Unique identifier of the repository example: 42 @@ -111813,7 +111855,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &802 + required: &816 - archive_url - assignees_url - blobs_url @@ -111964,10 +112006,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -112043,11 +112085,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: &765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: &779 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -112270,11 +112312,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: *765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: *779 sender: *4 required: - action @@ -112457,11 +112499,11 @@ x-webhooks: - everyone required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - rule: *765 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + rule: *779 sender: *4 required: - action @@ -112532,7 +112574,7 @@ x-webhooks: required: true content: application/json: - schema: &768 + schema: &782 title: Exemption request cancellation event type: object properties: @@ -112540,11 +112582,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: &766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: &780 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -112777,7 +112819,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &767 + items: &781 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -112885,7 +112927,7 @@ x-webhooks: required: true content: application/json: - schema: &769 + schema: &783 title: Exemption request completed event type: object properties: @@ -112893,11 +112935,11 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 sender: *4 required: - action @@ -112967,7 +113009,7 @@ x-webhooks: required: true content: application/json: - schema: &770 + schema: &784 title: Exemption request created event type: object properties: @@ -112975,11 +113017,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 sender: *4 required: - action @@ -113049,7 +113091,7 @@ x-webhooks: required: true content: application/json: - schema: &771 + schema: &785 title: Exemption response dismissed event type: object properties: @@ -113057,12 +113099,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 - exemption_response: *767 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 + exemption_response: *781 sender: *4 required: - action @@ -113134,7 +113176,7 @@ x-webhooks: required: true content: application/json: - schema: &772 + schema: &786 title: Exemption response submitted event type: object properties: @@ -113142,12 +113184,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - exemption_request: *766 - exemption_response: *767 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + exemption_request: *780 + exemption_response: *781 sender: *4 required: - action @@ -113220,7 +113262,7 @@ x-webhooks: required: true content: application/json: - schema: *768 + schema: *782 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113287,7 +113329,7 @@ x-webhooks: required: true content: application/json: - schema: *769 + schema: *783 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113354,7 +113396,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113421,7 +113463,7 @@ x-webhooks: required: true content: application/json: - schema: *771 + schema: *785 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113489,7 +113531,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -113567,7 +113609,7 @@ x-webhooks: type: string enum: - completed - check_run: &774 + check_run: &788 title: CheckRun description: A check performed on the code of a given code change type: object @@ -113668,7 +113710,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *773 + deployment: *787 details_url: example: https://example.com type: string @@ -113753,9 +113795,9 @@ x-webhooks: - output - app - pull_requests - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -114148,10 +114190,10 @@ x-webhooks: type: string enum: - created - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -114547,10 +114589,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 requested_action: description: The action requested by the user. type: object @@ -114955,10 +114997,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *774 - installation: *762 - organization: *763 - repository: *764 + check_run: *788 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - check_run @@ -115935,10 +115977,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -116608,10 +116650,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -117275,10 +117317,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -117586,20 +117628,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &775 + commit_oid: &789 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *761 - installation: *762 - organization: *763 - ref: &776 + enterprise: *775 + installation: *776 + organization: *777 + ref: &790 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -117991,12 +118033,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118259,12 +118301,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118593,12 +118635,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -118863,16 +118905,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *764 + repository: *778 sender: *4 required: - action @@ -119106,12 +119148,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *775 - enterprise: *761 - installation: *762 - organization: *763 - ref: *776 - repository: *764 + commit_oid: *789 + enterprise: *775 + installation: *776 + organization: *777 + ref: *790 + repository: *778 sender: *4 required: - action @@ -119368,10 +119410,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -119451,18 +119493,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *763 - pusher_type: &777 + organization: *777 + pusher_type: &791 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &778 + ref: &792 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -119472,7 +119514,7 @@ x-webhooks: enum: - tag - branch - repository: *764 + repository: *778 sender: *4 required: - ref @@ -119555,9 +119597,9 @@ x-webhooks: enum: - created definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119642,9 +119684,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119722,9 +119764,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119802,9 +119844,9 @@ x-webhooks: enum: - updated definition: *116 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -119881,10 +119923,10 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - repository: *764 - organization: *763 + enterprise: *775 + installation: *776 + repository: *778 + organization: *777 sender: *4 new_property_values: type: array @@ -119969,18 +120011,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - pusher_type: *777 - ref: *778 + enterprise: *775 + installation: *776 + organization: *777 + pusher_type: *791 + ref: *792 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *764 + repository: *778 sender: *4 required: - ref @@ -120065,10 +120107,10 @@ x-webhooks: enum: - auto_dismissed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120153,10 +120195,10 @@ x-webhooks: enum: - auto_reopened alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120241,10 +120283,10 @@ x-webhooks: enum: - created alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120327,10 +120369,10 @@ x-webhooks: enum: - dismissed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120413,10 +120455,10 @@ x-webhooks: enum: - fixed alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120500,10 +120542,10 @@ x-webhooks: enum: - reintroduced alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120586,10 +120628,10 @@ x-webhooks: enum: - reopened alert: *521 - installation: *762 - organization: *763 - enterprise: *761 - repository: *764 + installation: *776 + organization: *777 + enterprise: *775 + repository: *778 sender: *4 required: - action @@ -120666,9 +120708,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - key: &779 + enterprise: *775 + installation: *776 + key: &793 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -120704,8 +120746,8 @@ x-webhooks: - verified - created_at - read_only - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -120782,11 +120824,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - key: *779 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + key: *793 + organization: *777 + repository: *778 sender: *4 required: - action @@ -121347,12 +121389,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: &783 + workflow: &797 title: Workflow type: object nullable: true @@ -122082,9 +122124,9 @@ x-webhooks: pull_requests: type: array items: *615 - repository: *764 - organization: *763 - installation: *762 + repository: *778 + organization: *777 + installation: *776 sender: *4 responses: '200': @@ -122155,7 +122197,7 @@ x-webhooks: type: string enum: - approved - approver: &780 + approver: &794 type: object properties: avatar_url: @@ -122198,11 +122240,11 @@ x-webhooks: type: string comment: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - reviewers: &781 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + reviewers: &795 type: array items: type: object @@ -122281,7 +122323,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &782 + workflow_job_run: &796 type: object properties: conclusion: @@ -123012,18 +123054,18 @@ x-webhooks: type: string enum: - rejected - approver: *780 + approver: *794 comment: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - reviewers: *781 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + reviewers: *795 sender: *4 since: type: string - workflow_job_run: *782 + workflow_job_run: *796 workflow_job_runs: type: array items: @@ -123727,13 +123769,13 @@ x-webhooks: type: string enum: - requested - enterprise: *761 + enterprise: *775 environment: type: string - installation: *762 - organization: *763 - repository: *764 - requestor: &788 + installation: *776 + organization: *777 + repository: *778 + requestor: &802 title: User type: object nullable: true @@ -125632,12 +125674,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Deployment Workflow Run type: object @@ -126317,7 +126359,7 @@ x-webhooks: type: string enum: - answered - answer: &786 + answer: &800 type: object properties: author_association: @@ -126474,7 +126516,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &784 + discussion: &798 title: Discussion description: A Discussion in a repository. type: object @@ -126782,10 +126824,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -126912,11 +126954,11 @@ x-webhooks: - from required: - category - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -126999,11 +127041,11 @@ x-webhooks: type: string enum: - closed - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127085,7 +127127,7 @@ x-webhooks: type: string enum: - created - comment: &785 + comment: &799 type: object properties: author_association: @@ -127242,11 +127284,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127329,12 +127371,12 @@ x-webhooks: type: string enum: - deleted - comment: *785 - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + comment: *799 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127429,12 +127471,12 @@ x-webhooks: - from required: - body - comment: *785 - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + comment: *799 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127518,11 +127560,11 @@ x-webhooks: type: string enum: - created - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127604,11 +127646,11 @@ x-webhooks: type: string enum: - deleted - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127708,11 +127750,11 @@ x-webhooks: type: string required: - from - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127794,10 +127836,10 @@ x-webhooks: type: string enum: - labeled - discussion: *784 - enterprise: *761 - installation: *762 - label: &787 + discussion: *798 + enterprise: *775 + installation: *776 + label: &801 title: Label type: object properties: @@ -127829,8 +127871,8 @@ x-webhooks: - color - default - description - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127913,11 +127955,11 @@ x-webhooks: type: string enum: - locked - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -127999,11 +128041,11 @@ x-webhooks: type: string enum: - pinned - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128085,11 +128127,11 @@ x-webhooks: type: string enum: - reopened - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128174,16 +128216,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *784 - new_repository: *764 + new_discussion: *798 + new_repository: *778 required: - new_discussion - new_repository - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128266,10 +128308,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *784 - old_answer: *786 - organization: *763 - repository: *764 + discussion: *798 + old_answer: *800 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128351,12 +128393,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *784 - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128439,11 +128481,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128525,11 +128567,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *784 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + discussion: *798 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -128601,7 +128643,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128667,7 +128709,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128733,7 +128775,7 @@ x-webhooks: required: true content: application/json: - schema: *768 + schema: *782 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128799,7 +128841,7 @@ x-webhooks: required: true content: application/json: - schema: *769 + schema: *783 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128865,7 +128907,7 @@ x-webhooks: required: true content: application/json: - schema: *770 + schema: *784 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128931,7 +128973,7 @@ x-webhooks: required: true content: application/json: - schema: *771 + schema: *785 responses: '200': description: Return a 200 status to indicate that the data was received @@ -128997,7 +129039,7 @@ x-webhooks: required: true content: application/json: - schema: *772 + schema: *786 responses: '200': description: Return a 200 status to indicate that the data was received @@ -129064,7 +129106,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *761 + enterprise: *775 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -129724,9 +129766,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - forkee @@ -129872,9 +129914,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pages: description: The pages that were updated. type: array @@ -129911,7 +129953,7 @@ x-webhooks: - action - sha - html_url - repository: *764 + repository: *778 sender: *4 required: - pages @@ -129987,10 +130029,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: &789 + organization: *777 + repositories: &803 description: An array of repository objects that the installation can access. type: array @@ -130016,8 +130058,8 @@ x-webhooks: - name - full_name - private - repository: *764 - requester: *788 + repository: *778 + requester: *802 sender: *4 required: - action @@ -130092,11 +130134,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130172,11 +130214,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130252,10 +130294,10 @@ x-webhooks: type: string enum: - added - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories_added: &790 + organization: *777 + repositories_added: &804 description: An array of repository objects, which were added to the installation. type: array @@ -130301,15 +130343,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *764 - repository_selection: &791 + repository: *778 + repository_selection: &805 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *788 + requester: *802 sender: *4 required: - action @@ -130388,10 +130430,10 @@ x-webhooks: type: string enum: - removed - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories_added: *790 + organization: *777 + repositories_added: *804 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -130418,9 +130460,9 @@ x-webhooks: - name - full_name - private - repository: *764 - repository_selection: *791 - requester: *788 + repository: *778 + repository_selection: *805 + requester: *802 sender: *4 required: - action @@ -130499,11 +130541,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -130682,10 +130724,10 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 target_type: type: string @@ -130764,11 +130806,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *761 + enterprise: *775 installation: *22 - organization: *763 - repositories: *789 - repository: *764 + organization: *777 + repositories: *803 + repository: *778 requester: nullable: true sender: *4 @@ -131020,8 +131062,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -132177,8 +132219,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -132258,7 +132300,7 @@ x-webhooks: type: string enum: - deleted - comment: &792 + comment: &806 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -132423,8 +132465,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -133578,8 +133620,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -133659,7 +133701,7 @@ x-webhooks: type: string enum: - edited - changes: &820 + changes: &834 description: The changes to the comment. type: object properties: @@ -133671,9 +133713,9 @@ x-webhooks: type: string required: - from - comment: *792 - enterprise: *761 - installation: *762 + comment: *806 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -134828,8 +134870,8 @@ x-webhooks: - state - locked - assignee - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -134911,10 +134953,10 @@ x-webhooks: type: string enum: - assigned - assignee: *788 - enterprise: *761 - installation: *762 - issue: &795 + assignee: *802 + enterprise: *775 + installation: *776 + issue: &809 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -135833,8 +135875,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -135914,8 +135956,8 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -136974,8 +137016,8 @@ x-webhooks: required: - state - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -137054,8 +137096,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137969,8 +138011,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -138049,8 +138091,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138965,7 +139007,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &793 + milestone: &807 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139103,8 +139145,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -139203,8 +139245,8 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140123,9 +140165,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *787 - organization: *763 - repository: *764 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -140205,8 +140247,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141124,9 +141166,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *787 - organization: *763 - repository: *764 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -141206,8 +141248,8 @@ x-webhooks: type: string enum: - locked - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142126,8 +142168,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -142206,8 +142248,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143120,9 +143162,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *793 - organization: *763 - repository: *764 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -144565,8 +144607,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145484,8 +145526,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -145565,9 +145607,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *761 - installation: *762 - issue: &794 + enterprise: *775 + installation: *776 + issue: &808 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146479,8 +146521,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -146559,8 +146601,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147478,8 +147520,8 @@ x-webhooks: user_view_type: type: string type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -148942,11 +148984,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *761 - installation: *762 - issue: *794 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *808 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149026,12 +149068,12 @@ x-webhooks: type: string enum: - typed - enterprise: *761 - installation: *762 - issue: *795 + enterprise: *775 + installation: *776 + issue: *809 type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149112,7 +149154,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &823 + assignee: &837 title: User type: object nullable: true @@ -149182,11 +149224,11 @@ x-webhooks: required: - login - id - enterprise: *761 - installation: *762 - issue: *795 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *809 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149265,12 +149307,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *761 - installation: *762 - issue: *795 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *809 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -149350,8 +149392,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150268,8 +150310,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150349,11 +150391,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *761 - installation: *762 - issue: *794 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + issue: *808 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150432,12 +150474,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *761 - installation: *762 - issue: *795 + enterprise: *775 + installation: *776 + issue: *809 type: *289 - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150517,11 +150559,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150599,11 +150641,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150713,11 +150755,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - label: *787 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + label: *801 + organization: *777 + repository: *778 sender: *4 required: - action @@ -150799,9 +150841,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: &796 + enterprise: *775 + installation: *776 + marketplace_purchase: &810 title: Marketplace Purchase type: object required: @@ -150884,8 +150926,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *763 - previous_marketplace_purchase: &797 + organization: *777 + previous_marketplace_purchase: &811 title: Marketplace Purchase type: object properties: @@ -150965,7 +151007,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151045,10 +151087,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151131,7 +151173,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151213,10 +151255,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -151298,7 +151340,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *764 + repository: *778 sender: *4 required: - action @@ -151379,8 +151421,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 marketplace_purchase: title: Marketplace Purchase type: object @@ -151462,9 +151504,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *763 - previous_marketplace_purchase: *797 - repository: *764 + organization: *777 + previous_marketplace_purchase: *811 + repository: *778 sender: *4 required: - action @@ -151544,12 +151586,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *761 - installation: *762 - marketplace_purchase: *796 - organization: *763 - previous_marketplace_purchase: *797 - repository: *764 + enterprise: *775 + installation: *776 + marketplace_purchase: *810 + organization: *777 + previous_marketplace_purchase: *811 + repository: *778 sender: *4 required: - action @@ -151651,11 +151693,11 @@ x-webhooks: type: string required: - to - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151755,11 +151797,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151838,11 +151880,11 @@ x-webhooks: type: string enum: - removed - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 sender: *4 required: - action @@ -151920,11 +151962,11 @@ x-webhooks: type: string enum: - added - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152000,7 +152042,7 @@ x-webhooks: required: - login - id - team: &798 + team: &812 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -152190,11 +152232,11 @@ x-webhooks: type: string enum: - removed - enterprise: *761 - installation: *762 - member: *788 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + member: *802 + organization: *777 + repository: *778 scope: description: The scope of the membership. Currently, can only be `team`. @@ -152271,7 +152313,7 @@ x-webhooks: required: - login - id - team: *798 + team: *812 required: - action - scope @@ -152353,8 +152395,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *762 - merge_group: &800 + installation: *776 + merge_group: &814 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -152373,15 +152415,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *799 + head_commit: *813 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152467,10 +152509,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *762 - merge_group: *800 - organization: *763 - repository: *764 + installation: *776 + merge_group: *814 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152543,7 +152585,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 + enterprise: *775 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -152651,16 +152693,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *762 - organization: *763 + installation: *776 + organization: *777 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -152741,11 +152783,11 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -152824,9 +152866,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - milestone: &803 + enterprise: *775 + installation: *776 + milestone: &817 title: Milestone description: A collection of related issues and pull requests. type: object @@ -152963,8 +153005,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153043,11 +153085,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153157,11 +153199,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - milestone: *793 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *807 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153241,11 +153283,11 @@ x-webhooks: type: string enum: - opened - enterprise: *761 - installation: *762 - milestone: *803 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + milestone: *817 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153324,11 +153366,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *788 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + blocked_user: *802 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153407,11 +153449,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *788 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + blocked_user: *802 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153490,9 +153532,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - membership: &804 + enterprise: *775 + installation: *776 + membership: &818 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -153584,8 +153626,8 @@ x-webhooks: - role - organization_url - user - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153663,11 +153705,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -153746,8 +153788,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -153863,10 +153905,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 - user: *788 + user: *802 required: - action - invitation @@ -153944,11 +153986,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -154035,11 +154077,11 @@ x-webhooks: properties: from: type: string - enterprise: *761 - installation: *762 - membership: *804 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + membership: *818 + organization: *777 + repository: *778 sender: *4 required: - action @@ -154115,9 +154157,9 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 package: description: Information about the package. type: object @@ -154616,7 +154658,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &805 + items: &819 title: Ruby Gems metadata type: object properties: @@ -154711,7 +154753,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -154787,9 +154829,9 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 package: description: Information about the package. type: object @@ -155142,7 +155184,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *805 + items: *819 source_url: type: string format: uri @@ -155212,7 +155254,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -155389,12 +155431,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *761 + enterprise: *775 id: type: integer - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - id @@ -155471,7 +155513,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &806 + personal_access_token_request: &820 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -155617,10 +155659,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *761 - organization: *763 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155697,11 +155739,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *806 - enterprise: *761 - organization: *763 + personal_access_token_request: *820 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155777,11 +155819,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *806 - enterprise: *761 - organization: *763 + personal_access_token_request: *820 + enterprise: *775 + organization: *777 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155856,11 +155898,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *806 - organization: *763 - enterprise: *761 + personal_access_token_request: *820 + organization: *777 + enterprise: *775 sender: *4 - installation: *762 + installation: *776 required: - action - personal_access_token_request @@ -155965,7 +156007,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *807 + last_response: *821 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -155997,8 +156039,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 zen: description: Random string of GitHub zen. @@ -156243,10 +156285,10 @@ x-webhooks: - from required: - note - enterprise: *761 - installation: *762 - organization: *763 - project_card: &808 + enterprise: *775 + installation: *776 + organization: *777 + project_card: &822 title: Project Card type: object properties: @@ -156365,7 +156407,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -156446,11 +156488,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project_card: *808 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_card: *822 + repository: *778 sender: *4 required: - action @@ -156530,9 +156572,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 project_card: title: Project Card type: object @@ -156660,8 +156702,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -156755,11 +156797,11 @@ x-webhooks: - from required: - note - enterprise: *761 - installation: *762 - organization: *763 - project_card: *808 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_card: *822 + repository: *778 sender: *4 required: - action @@ -156853,9 +156895,9 @@ x-webhooks: - from required: - column_id - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 project_card: allOf: - title: Project Card @@ -157045,7 +157087,7 @@ x-webhooks: type: string required: - after_id - repository: *764 + repository: *778 sender: *4 required: - action @@ -157125,10 +157167,10 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - organization: *763 - project: &810 + enterprise: *775 + installation: *776 + organization: *777 + project: &824 title: Project type: object properties: @@ -157252,7 +157294,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -157332,10 +157374,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project_column: &809 + enterprise: *775 + installation: *776 + organization: *777 + project_column: &823 title: Project Column type: object properties: @@ -157374,7 +157416,7 @@ x-webhooks: - name - created_at - updated_at - repository: *764 + repository: *778 sender: *4 required: - action @@ -157453,18 +157495,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -157554,11 +157596,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 + repository: *778 sender: *4 required: - action @@ -157638,11 +157680,11 @@ x-webhooks: type: string enum: - moved - enterprise: *761 - installation: *762 - organization: *763 - project_column: *809 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project_column: *823 + repository: *778 sender: *4 required: - action @@ -157722,11 +157764,11 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -157806,18 +157848,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - project: *810 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *801 - required: *802 + properties: *815 + required: *816 nullable: true sender: *4 required: @@ -157919,11 +157961,11 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -158002,11 +158044,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 - organization: *763 - project: *810 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + project: *824 + repository: *778 sender: *4 required: - action @@ -158087,9 +158129,9 @@ x-webhooks: type: string enum: - closed - installation: *762 - organization: *763 - projects_v2: &811 + installation: *776 + organization: *777 + projects_v2: &825 title: Projects v2 Project description: A projects v2 project type: object @@ -158232,9 +158274,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158315,9 +158357,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158434,9 +158476,9 @@ x-webhooks: type: string to: type: string - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -158519,7 +158561,7 @@ x-webhooks: type: string enum: - archived - changes: &815 + changes: &829 type: object properties: archived_at: @@ -158533,9 +158575,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *762 - organization: *763 - projects_v2_item: &812 + installation: *776 + organization: *777 + projects_v2_item: &826 title: Projects v2 Item description: An item belonging to a project type: object @@ -158669,9 +158711,9 @@ x-webhooks: nullable: true to: type: string - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158753,9 +158795,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158836,9 +158878,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -158944,7 +158986,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &813 + - &827 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -158962,7 +159004,7 @@ x-webhooks: required: - id - name - - &814 + - &828 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -158985,8 +159027,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *813 - - *814 + - *827 + - *828 required: - field_value - type: object @@ -159002,9 +159044,9 @@ x-webhooks: nullable: true required: - body - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159099,9 +159141,9 @@ x-webhooks: to: type: string nullable: true - installation: *762 - organization: *763 - projects_v2_item: *812 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159184,10 +159226,10 @@ x-webhooks: type: string enum: - restored - changes: *815 - installation: *762 - organization: *763 - projects_v2_item: *812 + changes: *829 + installation: *776 + organization: *777 + projects_v2_item: *826 sender: *4 required: - action @@ -159269,9 +159311,9 @@ x-webhooks: type: string enum: - reopened - installation: *762 - organization: *763 - projects_v2: *811 + installation: *776 + organization: *777 + projects_v2: *825 sender: *4 required: - action @@ -159352,9 +159394,9 @@ x-webhooks: type: string enum: - created - installation: *762 - organization: *763 - projects_v2_status_update: &816 + installation: *776 + organization: *777 + projects_v2_status_update: &830 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -159481,9 +159523,9 @@ x-webhooks: type: string enum: - deleted - installation: *762 - organization: *763 - projects_v2_status_update: *816 + installation: *776 + organization: *777 + projects_v2_status_update: *830 sender: *4 required: - action @@ -159619,9 +159661,9 @@ x-webhooks: type: string format: date nullable: true - installation: *762 - organization: *763 - projects_v2_status_update: *816 + installation: *776 + organization: *777 + projects_v2_status_update: *830 sender: *4 required: - action @@ -159692,10 +159734,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - repository @@ -159772,13 +159814,13 @@ x-webhooks: type: string enum: - assigned - assignee: *788 - enterprise: *761 - installation: *762 - number: &817 + assignee: *802 + enterprise: *775 + installation: *776 + number: &831 description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -162061,7 +162103,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -162143,11 +162185,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -164425,7 +164467,7 @@ x-webhooks: - draft reason: type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -164507,11 +164549,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -166789,7 +166831,7 @@ x-webhooks: - draft reason: type: string - repository: *764 + repository: *778 sender: *4 required: - action @@ -166871,11 +166913,11 @@ x-webhooks: type: string enum: - closed - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: &818 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: &832 allOf: - *615 - type: object @@ -166939,7 +166981,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *764 + repository: *778 sender: *4 required: - action @@ -167020,12 +167062,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -167105,11 +167147,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *761 + enterprise: *775 milestone: *598 - number: *817 - organization: *763 - pull_request: &819 + number: *831 + organization: *777 + pull_request: &833 title: Pull Request type: object properties: @@ -169372,7 +169414,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -169451,11 +169493,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -171737,7 +171779,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *764 + repository: *778 sender: *4 required: - action @@ -171861,12 +171903,12 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -171946,11 +171988,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -174217,7 +174259,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -174297,11 +174339,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *761 - installation: *762 - label: *787 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + label: *801 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -176583,7 +176625,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -176664,10 +176706,10 @@ x-webhooks: type: string enum: - locked - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -178947,7 +178989,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -179027,12 +179069,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *761 + enterprise: *775 milestone: *598 - number: *817 - organization: *763 - pull_request: *819 - repository: *764 + number: *831 + organization: *777 + pull_request: *833 + repository: *778 sender: *4 required: - action @@ -179111,12 +179153,12 @@ x-webhooks: type: string enum: - opened - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179197,12 +179239,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179282,12 +179324,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *761 - installation: *762 - number: *817 - organization: *763 - pull_request: *818 - repository: *764 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 + pull_request: *832 + repository: *778 sender: *4 required: - action @@ -179653,9 +179695,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -181825,7 +181867,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -181905,7 +181947,7 @@ x-webhooks: type: string enum: - deleted - comment: &821 + comment: &835 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -182190,9 +182232,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -184350,7 +184392,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -184430,11 +184472,11 @@ x-webhooks: type: string enum: - edited - changes: *820 - comment: *821 - enterprise: *761 - installation: *762 - organization: *763 + changes: *834 + comment: *835 + enterprise: *775 + installation: *776 + organization: *777 pull_request: type: object properties: @@ -186595,7 +186637,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *764 + repository: *778 sender: *4 required: - action @@ -186676,9 +186718,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -188851,7 +188893,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 review: description: The review that was affected. type: object @@ -189094,9 +189136,9 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -191150,8 +191192,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 - review: &822 + repository: *778 + review: &836 description: The review that was affected. type: object properties: @@ -191380,12 +191422,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -193668,7 +193710,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_reviewer: title: User type: object @@ -193752,12 +193794,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -196047,7 +196089,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_team: title: Team description: Groups of organization members that gives permissions @@ -196239,12 +196281,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -198529,7 +198571,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_reviewer: title: User type: object @@ -198614,12 +198656,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *761 - installation: *762 + enterprise: *775 + installation: *776 number: description: The pull request number. type: integer - organization: *763 + organization: *777 pull_request: title: Pull Request type: object @@ -200895,7 +200937,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 requested_team: title: Team description: Groups of organization members that gives permissions @@ -201076,9 +201118,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -203253,8 +203295,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 - review: *822 + repository: *778 + review: *836 sender: *4 required: - action @@ -203334,9 +203376,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -205406,7 +205448,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 sender: *4 thread: type: object @@ -205789,9 +205831,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 pull_request: title: Simple Pull Request type: object @@ -207847,7 +207889,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *764 + repository: *778 sender: *4 thread: type: object @@ -208233,10 +208275,10 @@ x-webhooks: type: string before: type: string - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -210507,7 +210549,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -210589,11 +210631,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *823 - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + assignee: *837 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -212876,7 +212918,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -212955,11 +212997,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *761 - installation: *762 - label: *787 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + label: *801 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -215232,7 +215274,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -215313,10 +215355,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *761 - installation: *762 - number: *817 - organization: *763 + enterprise: *775 + installation: *776 + number: *831 + organization: *777 pull_request: title: Pull Request type: object @@ -217581,7 +217623,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *764 + repository: *778 sender: *4 required: - action @@ -217781,7 +217823,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *761 + enterprise: *775 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -217873,8 +217915,8 @@ x-webhooks: - url - author - committer - installation: *762 - organization: *763 + installation: *776 + organization: *777 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -218449,9 +218491,9 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 registry_package: type: object properties: @@ -218897,7 +218939,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *805 + items: *819 summary: type: string tag_name: @@ -218951,7 +218993,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -219029,9 +219071,9 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 registry_package: type: object properties: @@ -219339,7 +219381,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *805 + items: *819 summary: type: string tag_name: @@ -219388,7 +219430,7 @@ x-webhooks: - owner - package_version - registry - repository: *764 + repository: *778 sender: *4 required: - action @@ -219465,10 +219507,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - release: &824 + enterprise: *775 + installation: *776 + organization: *777 + release: &838 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -219777,7 +219819,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *764 + repository: *778 sender: *4 required: - action @@ -219854,11 +219896,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -219975,11 +220017,11 @@ x-webhooks: type: boolean required: - to - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -220057,9 +220099,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -220372,7 +220414,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *764 + repository: *778 sender: *4 required: - action @@ -220448,10 +220490,10 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - release: &825 + enterprise: *775 + installation: *776 + organization: *777 + release: &839 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -220761,7 +220803,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *764 + repository: *778 sender: *4 required: - action @@ -220837,11 +220879,11 @@ x-webhooks: type: string enum: - released - enterprise: *761 - installation: *762 - organization: *763 - release: *824 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *838 + repository: *778 sender: *4 required: - action @@ -220917,11 +220959,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *761 - installation: *762 - organization: *763 - release: *825 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + release: *839 + repository: *778 sender: *4 required: - action @@ -220997,11 +221039,11 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - repository_advisory: *672 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + repository_advisory: *686 sender: *4 required: - action @@ -221077,11 +221119,11 @@ x-webhooks: type: string enum: - reported - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - repository_advisory: *672 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + repository_advisory: *686 sender: *4 required: - action @@ -221157,10 +221199,10 @@ x-webhooks: type: string enum: - archived - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221237,10 +221279,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221318,10 +221360,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221405,10 +221447,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221520,10 +221562,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221595,10 +221637,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 status: type: string @@ -221679,10 +221721,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221759,10 +221801,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221856,10 +221898,10 @@ x-webhooks: - name required: - repository - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -221939,10 +221981,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 sender: *4 required: @@ -222021,10 +222063,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 sender: *4 required: @@ -222103,10 +222145,10 @@ x-webhooks: type: string enum: - edited - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 repository_ruleset: *130 changes: type: object @@ -222411,10 +222453,10 @@ x-webhooks: - from required: - owner - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222492,10 +222534,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222573,7 +222615,7 @@ x-webhooks: type: string enum: - create - alert: &826 + alert: &840 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -222694,10 +222736,10 @@ x-webhooks: type: string enum: - open - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222903,10 +222945,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -222984,11 +223026,11 @@ x-webhooks: type: string enum: - reopen - alert: *826 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *840 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223187,10 +223229,10 @@ x-webhooks: enum: - fixed - open - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223268,7 +223310,7 @@ x-webhooks: type: string enum: - created - alert: &827 + alert: &841 type: object properties: number: *100 @@ -223379,10 +223421,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223463,11 +223505,11 @@ x-webhooks: type: string enum: - created - alert: *827 - installation: *762 - location: *828 - organization: *763 - repository: *764 + alert: *841 + installation: *776 + location: *842 + organization: *777 + repository: *778 sender: *4 required: - location @@ -223705,11 +223747,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223787,11 +223829,11 @@ x-webhooks: type: string enum: - reopened - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223869,11 +223911,11 @@ x-webhooks: type: string enum: - resolved - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -223951,11 +223993,11 @@ x-webhooks: type: string enum: - validated - alert: *827 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + alert: *841 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -224081,10 +224123,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *764 - enterprise: *761 - installation: *762 - organization: *763 + repository: *778 + enterprise: *775 + installation: *776 + organization: *777 sender: *4 required: - action @@ -224162,11 +224204,11 @@ x-webhooks: type: string enum: - published - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - security_advisory: &829 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + security_advisory: &843 description: The details of the security advisory, including summary, description, and severity. type: object @@ -224349,11 +224391,11 @@ x-webhooks: type: string enum: - updated - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 - security_advisory: *829 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 + security_advisory: *843 sender: *4 required: - action @@ -224426,10 +224468,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -224614,9 +224656,9 @@ x-webhooks: type: object properties: security_and_analysis: *328 - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: *392 sender: *4 required: @@ -224695,12 +224737,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: &830 + sponsorship: &844 type: object properties: created_at: @@ -225001,12 +225043,12 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - sponsorship @@ -225094,12 +225136,12 @@ x-webhooks: type: string required: - from - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225176,17 +225218,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &831 + effective_date: &845 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - sponsorship @@ -225260,7 +225302,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &832 + changes: &846 type: object properties: tier: @@ -225304,13 +225346,13 @@ x-webhooks: - from required: - tier - effective_date: *831 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + effective_date: *845 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225387,13 +225429,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *832 - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + changes: *846 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - sponsorship: *830 + sponsorship: *844 required: - action - changes @@ -225467,10 +225509,10 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225553,10 +225595,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225976,15 +226018,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *761 + enterprise: *775 id: description: The unique identifier of the status. type: integer - installation: *762 + installation: *776 name: type: string - organization: *763 - repository: *764 + organization: *777 + repository: *778 sender: *4 sha: description: The Commit SHA. @@ -226099,9 +226141,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226191,9 +226233,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226283,9 +226325,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226375,9 +226417,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *155 - installation: *762 - organization: *763 - repository: *764 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -226454,12 +226496,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - team: &833 + team: &847 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -226649,9 +226691,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -227109,7 +227151,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -227185,9 +227227,9 @@ x-webhooks: type: string enum: - created - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -227645,7 +227687,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -227722,9 +227764,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -228182,7 +228224,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -228326,9 +228368,9 @@ x-webhooks: - from required: - permissions - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -228786,7 +228828,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - changes @@ -228864,9 +228906,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *761 - installation: *762 - organization: *763 + enterprise: *775 + installation: *776 + organization: *777 repository: title: Repository description: A git repository @@ -229324,7 +229366,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *833 + team: *847 required: - action - team @@ -229400,10 +229442,10 @@ x-webhooks: type: string enum: - started - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 required: - action @@ -229476,16 +229518,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *761 + enterprise: *775 inputs: type: object nullable: true additionalProperties: true - installation: *762 - organization: *763 + installation: *776 + organization: *777 ref: type: string - repository: *764 + repository: *778 sender: *4 workflow: type: string @@ -229567,10 +229609,10 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: allOf: @@ -229886,10 +229928,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: allOf: @@ -230228,10 +230270,10 @@ x-webhooks: type: string enum: - queued - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: type: object @@ -230445,10 +230487,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 workflow_job: type: object @@ -230664,12 +230706,12 @@ x-webhooks: type: string enum: - completed - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object @@ -231668,12 +231710,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object @@ -232657,12 +232699,12 @@ x-webhooks: type: string enum: - requested - enterprise: *761 - installation: *762 - organization: *763 - repository: *764 + enterprise: *775 + installation: *776 + organization: *777 + repository: *778 sender: *4 - workflow: *783 + workflow: *797 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 7429af9cf7..439e9b6fae 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -116051,1424 +116051,1214 @@ "used_in_tests" ] }, - "organization-secret-scanning-alert": { + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "url": { - "$ref": "#/components/schemas/alert-url" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, - "locations_url": { + "blob_sha": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "resolved_at": { + "blob_url": { "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "description": "The API URL to get the associated blob resource" }, - "secret_type": { + "commit_sha": { "type": "string", - "description": "The type of secret that secret scanning detected." + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "secret_type_display_name": { + "commit_url": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { "type": "string", - "description": "The secret that was detected." + "description": "The file path of the wiki page", + "example": "/example/Home.md" }, - "repository": { - "$ref": "#/components/schemas/simple-repository" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "push_protection_bypass_request_reviewer_comment": { + "page_url": { "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "push_protection_bypass_request_comment": { + "commit_sha": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "push_protection_bypass_request_html_url": { + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { "type": "string", "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" } - } + }, + "required": [ + "issue_comment_url" + ] }, - "actions-billing-usage": { + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", "type": "object", "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { - "type": "object", - "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." - }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." - } - } + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" } }, "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" + "discussion_title_url" ] }, - "advanced-security-active-committers-user": { + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", "type": "object", "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "example": "2021-11-03" - }, - "last_pushed_email": { + "discussion_body_url": { "type": "string", - "example": "monalisa@github.com" + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" } }, "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" + "discussion_body_url" ] }, - "advanced-security-active-committers-repository": { + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", "type": "object", "properties": { - "name": { + "discussion_comment_url": { "type": "string", - "example": "octocat/Hello-World" - }, - "advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-user" - } + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" } }, "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" + "discussion_comment_url" ] }, - "advanced-security-active-committers": { + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", "type": "object", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-repository" - } + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ - "repositories" + "pull_request_title_url" ] }, - "get-all-cost-centers": { + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", "type": "object", "properties": { - "costCenters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the cost center." - }, - "name": { - "type": "string", - "description": "Name of the cost center." - }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } - } - }, - "required": [ - "id", - "name", - "resources" - ] - } + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } - } + }, + "required": [ + "pull_request_body_url" + ] }, - "packages-billing-usage": { + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", "type": "object", "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." - }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" } }, "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" + "pull_request_comment_url" ] }, - "combined-billing-usage": { + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", "type": "object", "properties": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." - }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." - }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" } }, "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" + "pull_request_review_url" ] }, - "billing-usage-report": { + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", "type": "object", "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" } - } + }, + "required": [ + "pull_request_review_comment_url" + ] }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" }, - "login": { - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" }, - "display_login": { - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, - "gravatar_id": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" }, - "avatar_url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + ], + "nullable": true }, - "nullable-milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "organization-secret-scanning-alert": { "type": "object", "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + "$ref": "#/components/schemas/alert-html-url" }, - "labels_url": { + "locations_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 + "description": "The REST API URL of the code locations for this alert." }, "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "$ref": "#/components/schemas/secret-scanning-alert-state" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" }, - "description": { + "resolved_at": { "type": "string", - "example": "Tracking milestone for version 1.0", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "creator": { + "resolved_by": { "$ref": "#/components/schemas/nullable-simple-user" }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { + "secret_type": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "description": "The type of secret that secret scanning detected." }, - "updated_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "closed_at": { + "secret": { "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", "nullable": true }, - "due_on": { + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", "format": "date-time", - "example": "2012-10-09T23:39:01Z", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "issue-type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "name": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "description": "The name of the issue type." + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "description": { + "push_protection_bypass_request_comment": { "type": "string", - "description": "The description of the issue type.", + "description": "An optional comment when requesting a push protection bypass.", "nullable": true }, - "color": { + "push_protection_bypass_request_html_url": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "format": "uri", + "description": "The URL to a push protection bypass request.", "nullable": true }, - "created_at": { + "resolution_comment": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "The comment that was optionally added when this alert was closed", + "nullable": true }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { + "validity": { "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" ] }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true }, - "description": { - "type": "string", - "example": "The description of the app.", + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", "nullable": true }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + } + } + }, + "actions-billing-usage": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "minutes_used_breakdown": { "type": "object", "properties": { - "issues": { - "type": "string" + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." }, - "checks": { - "type": "string" + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." }, - "metadata": { - "type": "string" + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." }, - "contents": { - "type": "string" + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." }, - "deployments": { - "type": "string" + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" ] }, - "author-association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "advanced-security-active-committers-user": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" ] }, - "reaction-rollup": { - "title": "Reaction Rollup", + "advanced-security-active-committers-repository": { "type": "object", "properties": { - "url": { + "name": { "type": "string", - "format": "uri" + "example": "octocat/Hello-World" }, - "total_count": { - "type": "integer" + "advanced_security_committers": { + "type": "integer", + "example": 25 }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-user" + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + }, + "advanced-security-active-committers": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "example": 25 }, - "laugh": { - "type": "integer" + "total_count": { + "type": "integer", + "example": 2 }, - "confused": { - "type": "integer" + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" }, - "heart": { - "type": "integer" + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" }, - "hooray": { - "type": "integer" + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + } + } + }, + "required": [ + "repositories" + ] + }, + "get-all-cost-centers": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "packages-billing-usage": { + "type": "object", + "properties": { + "total_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, - "eyes": { - "type": "integer" + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." }, - "rocket": { - "type": "integer" + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" ] }, - "sub-issues-summary": { - "title": "Sub-issues Summary", + "combined-billing-usage": { "type": "object", "properties": { - "total": { - "type": "integer" + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." }, - "completed": { - "type": "integer" + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." }, - "percent_completed": { - "type": "integer" + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." } }, "required": [ - "total", - "completed", - "percent_completed" + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" ] }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, + "actor": { + "title": "Actor", + "description": "Actor", "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64" + "type": "integer" }, - "node_id": { + "login": { "type": "string" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { + "display_login": { "type": "string" }, - "comments_url": { + "gravatar_id": { "type": "string", - "format": "uri" + "nullable": true }, - "events_url": { + "url": { "type": "string", "format": "uri" }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "labels_url": { "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned" - ] + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" + "id": { + "type": "integer", + "example": 1002604 }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "node_id": { "type": "string", - "nullable": true + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" + "default": "open" }, - "locked": { - "type": "boolean" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "active_lock_reason": { + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "comments": { - "type": "integer" + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "open_issues": { + "type": "integer", + "example": 4 }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "closed_issues": { + "type": "integer", + "example": 8 }, "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "timeline_url": { + "closed_at": { "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/issue-type" - }, - "repository": { - "$ref": "#/components/schemas/repository" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "sub_issues_summary": { - "$ref": "#/components/schemas/sub-issues-summary" + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ - "assignee", + "closed_issues", + "creator", + "description", + "due_on", "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", "labels_url", - "milestone", + "html_url", "number", - "repository_url", + "open_issues", "state", - "locked", "title", "url", - "user", - "author_association", "created_at", "updated_at" - ] + ], + "nullable": true }, - "issue-comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", - "format": "int64" + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" + "description": "The node identifier of the issue type." }, - "body_html": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the issue type." }, - "html_url": { + "description": { "type": "string", - "format": "uri" + "description": "The description of the issue type.", + "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "description": "The time the issue type created.", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" + "name", + "description" ] }, - "event": { - "title": "Event", - "description": "Event", + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "type": { + "node_id": { "type": "string", - "nullable": true + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "actor": { - "$ref": "#/components/schemas/actor" + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/enterprise" } - }, - "required": [ - "id", - "name", - "url" ] }, - "org": { - "$ref": "#/components/schemas/actor" + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" }, - "payload": { + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "action": { + "issues": { "type": "string" }, - "issue": { - "$ref": "#/components/schemas/issue" + "checks": { + "type": "string" }, - "comment": { - "$ref": "#/components/schemas/issue-comment" + "metadata": { + "type": "string" }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "public": { - "type": "boolean" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - }, - "link-with-type": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "feed": { - "title": "Feed", - "description": "Feed", + "author-association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reaction-rollup": { + "title": "Reaction Rollup", "type": "object", "properties": { - "timeline_url": { + "url": { "type": "string", - "example": "https://github.com/timeline" + "format": "uri" }, - "user_url": { - "type": "string", - "example": "https://github.com/{user}" + "total_count": { + "type": "integer" }, - "current_user_public_url": { - "type": "string", - "example": "https://github.com/octocat" + "+1": { + "type": "integer" }, - "current_user_url": { - "type": "string", - "example": "https://github.com/octocat.private?token=abc123" + "-1": { + "type": "integer" }, - "current_user_actor_url": { - "type": "string", - "example": "https://github.com/octocat.private.actor?token=abc123" + "laugh": { + "type": "integer" }, - "current_user_organization_url": { - "type": "string", - "example": "https://github.com/octocat-org" + "confused": { + "type": "integer" }, - "current_user_organization_urls": { - "type": "array", - "example": [ - "https://github.com/organizations/github/octocat.private.atom?token=abc123" - ], - "items": { - "type": "string", - "format": "uri" - } + "heart": { + "type": "integer" }, - "security_advisories_url": { - "type": "string", - "example": "https://github.com/security-advisories" + "hooray": { + "type": "integer" }, - "repository_discussions_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions", - "description": "A feed of discussions for a given repository." + "eyes": { + "type": "integer" }, - "repository_discussions_category_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", - "description": "A feed of discussions for a given repository and category." + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "_links": { - "type": "object", - "properties": { - "timeline": { - "$ref": "#/components/schemas/link-with-type" - }, - "user": { - "$ref": "#/components/schemas/link-with-type" - }, - "security_advisories": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_public": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_actor": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organization": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organizations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "repository_discussions": { - "$ref": "#/components/schemas/link-with-type" - }, - "repository_discussions_category": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "required": [ - "timeline", - "user" - ] + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" } }, "required": [ - "_links", - "timeline_url", - "user_url" + "total", + "completed", + "percent_completed" ] }, - "base-gist": { - "title": "Base Gist", - "description": "Base Gist", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "format": "int64" }, - "forks_url": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "commits_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "type": "string" - }, - "node_id": { + "labels_url": { "type": "string" }, - "git_pull_url": { + "comments_url": { "type": "string", "format": "uri" }, - "git_push_url": { + "events_url": { "type": "string", "format": "uri" }, @@ -117476,510 +117266,524 @@ "type": "string", "format": "uri" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" }, - "public": { - "type": "boolean" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" }, - "created_at": { + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", "type": "string", - "format": "date-time" + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned" + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" }, - "description": { + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "history": { + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { "type": "array", - "items": {} + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", "user", - "files", + "author_association", "created_at", "updated_at" ] }, - "public-user": { - "title": "Public User", - "description": "Public User", + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, - "user_view_type": { - "type": "string" - }, "node_id": { "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "gists_url": { + "body_text": { "type": "string" }, - "starred_url": { + "body_html": { "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "name": { + "issue_url": { "type": "string", - "nullable": true + "format": "uri" }, - "company": { - "type": "string", - "nullable": true + "author_association": { + "$ref": "#/components/schemas/author-association" }, - "blog": { - "type": "string", - "nullable": true + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" }, - "location": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "notification_email": { - "type": "string", - "format": "email", - "nullable": true - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" }, - "twitter_username": { + "type": { "type": "string", "nullable": true }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "actor": { + "$ref": "#/components/schemas/actor" }, - "plan": { + "repo": { "type": "object", "properties": { - "collaborators": { + "id": { "type": "integer" }, "name": { "type": "string" }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "collaborators", + "id", "name", - "space", - "private_repos" + "url" ] }, - "private_gists": { - "type": "integer", - "example": 1 - }, - "total_private_repos": { - "type": "integer", - "example": 2 + "org": { + "$ref": "#/components/schemas/actor" }, - "owned_private_repos": { - "type": "integer", - "example": 2 + "payload": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "comment": { + "$ref": "#/components/schemas/issue-comment" + }, + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + } }, - "disk_usage": { - "type": "integer", - "example": 1 + "public": { + "type": "boolean" }, - "collaborators": { - "type": "integer", - "example": 3 + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "actor", + "repo", + "payload", + "public", + "created_at" + ] }, - "gist-history": { - "title": "Gist History", - "description": "Gist History", + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", "type": "object", "properties": { - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "href": { + "type": "string" }, - "version": { + "type": { "type": "string" + } + }, + "required": [ + "href", + "type" + ] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" }, - "committed_at": { + "user_url": { "type": "string", - "format": "date-time" + "example": "https://github.com/{user}" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" + }, + "current_user_url": { + "type": "string", + "example": "https://github.com/octocat.private?token=abc123" + }, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { + "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "items": { + "type": "string", + "format": "uri" } }, - "url": { + "security_advisories_url": { "type": "string", - "format": "uri" - } - } - }, - "gist-simple": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "$ref": "#/components/schemas/public-user" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } + "example": "https://github.com/security-advisories" }, - "history": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/gist-history" - } + "repository_discussions_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions", + "description": "A feed of discussions for a given repository." }, - "fork_of": { - "nullable": true, - "title": "Gist", - "description": "Gist", + "repository_discussions_category_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", + "description": "A feed of discussions for a given repository and category." + }, + "_links": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" + "timeline": { + "$ref": "#/components/schemas/link-with-type" }, - "commits_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/link-with-type" }, - "id": { - "type": "string" + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" }, - "node_id": { - "type": "string" + "current_user": { + "$ref": "#/components/schemas/link-with-type" }, - "git_pull_url": { - "type": "string", - "format": "uri" + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" }, - "git_push_url": { - "type": "string", - "format": "uri" + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" }, - "html_url": { - "type": "string", - "format": "uri" + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } + "current_user_organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/link-with-type" } }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "repository_discussions": { + "$ref": "#/components/schemas/link-with-type" }, - "history": { - "type": "array", - "items": {} + "repository_discussions_category": { + "$ref": "#/components/schemas/link-with-type" } }, "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" + "timeline", + "user" ] - }, + } + }, + "required": [ + "_links", + "timeline_url", + "user_url" + ] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri" }, "forks_url": { - "type": "string" + "type": "string", + "format": "uri" }, "commits_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "string" @@ -117988,18 +117792,20 @@ "type": "string" }, "git_pull_url": { - "type": "string" + "type": "string", + "format": "uri" }, "git_push_url": { - "type": "string" + "type": "string", + "format": "uri" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "files": { "type": "object", "additionalProperties": { - "nullable": true, "type": "object", "properties": { "filename": { @@ -118017,12 +117823,6 @@ "size": { "type": "integer" }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", @@ -118035,10 +117835,12 @@ "type": "boolean" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "description": { "type": "string", @@ -118051,460 +117853,985 @@ "type": "boolean" }, "user": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/nullable-simple-user" }, "comments_url": { - "type": "string" + "type": "string", + "format": "uri" }, "owner": { "$ref": "#/components/schemas/simple-user" }, "truncated": { "type": "boolean" - } - } - }, - "gist-comment": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDExOkdpc3RDb21tZW50MQ==" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + "forks": { + "type": "array", + "items": {} }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535, - "example": "Body of the attachment" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" + "history": { + "type": "array", + "items": {} } }, "required": [ - "url", "id", "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", "user", - "body", - "author_association", + "files", "created_at", "updated_at" ] }, - "gist-commit": { - "title": "Gist Commit", - "description": "Gist Commit", + "public-user": { + "title": "Public User", + "description": "Public User", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + "login": { + "type": "string" }, - "version": { - "type": "string", - "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + "id": { + "type": "integer", + "format": "int64" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "user_view_type": { + "type": "string" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "node_id": { + "type": "string" }, - "committed_at": { - "type": "string", - "format": "date-time", - "example": "2010-04-14T02:15:15Z" - } - }, - "required": [ - "url", - "user", - "version", - "committed_at", - "change_status" - ] - }, - "gitignore-template": { - "title": "Gitignore Template", - "description": "Gitignore Template", - "type": "object", - "properties": { - "name": { + "avatar_url": { "type": "string", - "example": "C" + "format": "uri" }, - "source": { + "gravatar_id": { "type": "string", - "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" - } - }, - "required": [ - "name", - "source" - ] - }, - "license-simple": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { + "nullable": true + }, + "url": { "type": "string", - "example": "mit" + "format": "uri" }, - "name": { + "html_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { + "followers_url": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "format": "uri" }, - "spdx_id": { + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { "type": "string", - "nullable": true, - "example": "MIT" + "format": "uri" }, - "node_id": { + "organizations_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - }, - "license": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { + }, + "events_url": { + "type": "string" + }, + "received_events_url": { "type": "string", - "example": "mit" + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" }, "name": { "type": "string", - "example": "MIT License" + "nullable": true }, - "spdx_id": { + "company": { "type": "string", - "example": "MIT", "nullable": true }, - "url": { + "blog": { "type": "string", - "format": "uri", - "example": "https://api.github.com/licenses/mit", "nullable": true }, - "node_id": { + "location": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "nullable": true }, - "html_url": { + "email": { "type": "string", - "format": "uri", - "example": "http://choosealicense.com/licenses/mit/" + "format": "email", + "nullable": true }, - "description": { + "notification_email": { "type": "string", - "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + "format": "email", + "nullable": true }, - "implementation": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { "type": "string", - "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + "nullable": true }, - "permissions": { - "type": "array", - "example": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ], - "items": { - "type": "string" - } + "twitter_username": { + "type": "string", + "nullable": true }, - "conditions": { - "type": "array", - "example": [ - "include-copyright" - ], - "items": { - "type": "string" - } + "public_repos": { + "type": "integer" }, - "limitations": { - "type": "array", - "example": [ - "no-liability" - ], - "items": { - "type": "string" - } + "public_gists": { + "type": "integer" }, - "body": { + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { "type": "string", - "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + "format": "date-time" }, - "featured": { - "type": "boolean", - "example": true - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] - }, - "marketplace-listing-plan": { - "title": "Marketplace Listing Plan", - "description": "Marketplace Listing Plan", - "type": "object", - "properties": { - "url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313" + "format": "date-time" }, - "accounts_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] }, - "id": { + "private_gists": { "type": "integer", - "example": 1313 + "example": 1 }, - "number": { + "total_private_repos": { "type": "integer", - "example": 3 - }, - "name": { - "type": "string", - "example": "Pro" - }, - "description": { - "type": "string", - "example": "A professional-grade CI solution" + "example": 2 }, - "monthly_price_in_cents": { + "owned_private_repos": { "type": "integer", - "example": 1099 + "example": 2 }, - "yearly_price_in_cents": { + "disk_usage": { "type": "integer", - "example": 11870 - }, - "price_model": { - "type": "string", - "enum": [ - "FREE", - "FLAT_RATE", - "PER_UNIT" - ], - "example": "FLAT_RATE" - }, - "has_free_trial": { - "type": "boolean", - "example": true - }, - "unit_name": { - "type": "string", - "nullable": true - }, - "state": { - "type": "string", - "example": "published" + "example": 1 }, - "bullets": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "Up to 25 private repositories", - "11 concurrent builds" - ] + "collaborators": { + "type": "integer", + "example": 3 } }, "required": [ - "url", - "accounts_url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", "name", - "description", - "has_free_trial", - "price_model", - "unit_name", - "monthly_price_in_cents", - "state", - "yearly_price_in_cents", - "bullets" - ] + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false }, - "marketplace-purchase": { - "title": "Marketplace Purchase", - "description": "Marketplace Purchase", + "gist-history": { + "title": "Gist History", + "description": "Gist History", "type": "object", "properties": { - "url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "organization_billing_email": { + "version": { "type": "string" }, - "email": { + "committed_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "marketplace_pending_change": { + "change_status": { "type": "object", "properties": { - "is_installed": { - "type": "boolean" - }, - "effective_date": { - "type": "string" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "id": { + "total": { "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" - } - }, - "nullable": true - }, - "marketplace_purchase": { - "type": "object", - "properties": { - "billing_cycle": { - "type": "string" - }, - "next_billing_date": { - "type": "string", - "nullable": true - }, - "is_installed": { - "type": "boolean" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "on_free_trial": { - "type": "boolean" - }, - "free_trial_ends_on": { - "type": "string", - "nullable": true - }, - "updated_at": { - "type": "string" + "additions": { + "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" + "deletions": { + "type": "integer" } } + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "url", - "id", - "type", - "login", - "marketplace_purchase" - ] + } }, - "api-overview": { - "title": "Api Overview", - "description": "Api Overview", + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", "type": "object", "properties": { - "verifiable_password_authentication": { - "type": "boolean", - "example": true - }, - "ssh_key_fingerprints": { - "type": "object", - "properties": { + "forks": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/public-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "history": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-history" + } + }, + "fork_of": { + "nullable": true, + "title": "Gist", + "description": "Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + } + } + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": [ + "url", + "user", + "version", + "committed_at", + "change_status" + ] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "C" + }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": [ + "name", + "source" + ] + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "spdx_id": { + "type": "string", + "example": "MIT", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "example": [ + "include-copyright" + ], + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "example": [ + "no-liability" + ], + "items": { + "type": "string" + } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { + "type": "boolean", + "example": true + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { + "type": "integer", + "example": 1313 + }, + "number": { + "type": "integer", + "example": 3 + }, + "name": { + "type": "string", + "example": "Pro" + }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { + "type": "integer", + "example": 1099 + }, + "yearly_price_in_cents": { + "type": "integer", + "example": 11870 + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ], + "example": "FLAT_RATE" + }, + "has_free_trial": { + "type": "boolean", + "example": true + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "example": "published" + }, + "bullets": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "organization_billing_email": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true + }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { + "type": "boolean" + }, + "effective_date": { + "type": "string" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "id": { + "type": "integer" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { + "type": "string" + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "is_installed": { + "type": "boolean" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": [ + "url", + "id", + "type", + "login", + "marketplace_purchase" + ] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { "SHA256_RSA": { "type": "string" }, @@ -139396,27 +139723,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139426,7 +139733,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139436,7 +139743,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139446,412 +139753,156 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] - } - ] - }, - "secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "resolution_comment": { - "type": "string", - "description": "An optional comment to resolve an alert.", - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the detected secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - } - } - }, - "secret-scanning-alert-resolution-comment": { - "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", - "type": "string", - "nullable": true - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } - }, - "required": [ - "issue_title_url" ] }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "secret-scanning-alert": { "type": "object", "properties": { - "issue_body_url": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "pull_request_review_comment_url" - ] + } + }, + "secret-scanning-alert-resolution-comment": { + "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", + "type": "string", + "nullable": true }, "secret-scanning-location": { "type": "object", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index bfc6f64a56..c64bb395a0 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -84528,6 +84528,264 @@ components: - wont_fix - revoked - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true organization-secret-scanning-alert: type: object properties: @@ -84621,6 +84879,8 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" actions-billing-usage: type: object properties: @@ -102731,249 +102991,13 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 7429af9cf7..439e9b6fae 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -116051,1424 +116051,1214 @@ "used_in_tests" ] }, - "organization-secret-scanning-alert": { + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "url": { - "$ref": "#/components/schemas/alert-url" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, - "locations_url": { + "blob_sha": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "resolved_at": { + "blob_url": { "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "description": "The API URL to get the associated blob resource" }, - "secret_type": { + "commit_sha": { "type": "string", - "description": "The type of secret that secret scanning detected." + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "secret_type_display_name": { + "commit_url": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { "type": "string", - "description": "The secret that was detected." + "description": "The file path of the wiki page", + "example": "/example/Home.md" }, - "repository": { - "$ref": "#/components/schemas/simple-repository" + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" }, - "push_protection_bypass_request_reviewer_comment": { + "page_url": { "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "push_protection_bypass_request_comment": { + "commit_sha": { "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "push_protection_bypass_request_html_url": { + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { "type": "string", "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "resolution_comment": { + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { "type": "string", - "description": "The comment that was optionally added when this alert was closed", - "nullable": true - }, - "validity": { + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" } - } + }, + "required": [ + "issue_comment_url" + ] }, - "actions-billing-usage": { + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", "type": "object", "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { - "type": "object", - "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." - }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." - } - } + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" } }, "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" + "discussion_title_url" ] }, - "advanced-security-active-committers-user": { + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", "type": "object", "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "example": "2021-11-03" - }, - "last_pushed_email": { + "discussion_body_url": { "type": "string", - "example": "monalisa@github.com" + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" } }, "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" + "discussion_body_url" ] }, - "advanced-security-active-committers-repository": { + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", "type": "object", "properties": { - "name": { + "discussion_comment_url": { "type": "string", - "example": "octocat/Hello-World" - }, - "advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-user" - } + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" } }, "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" + "discussion_comment_url" ] }, - "advanced-security-active-committers": { + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", "type": "object", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-repository" - } + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ - "repositories" + "pull_request_title_url" ] }, - "get-all-cost-centers": { + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", "type": "object", "properties": { - "costCenters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the cost center." - }, - "name": { - "type": "string", - "description": "Name of the cost center." - }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } - } - }, - "required": [ - "id", - "name", - "resources" - ] - } + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } - } + }, + "required": [ + "pull_request_body_url" + ] }, - "packages-billing-usage": { + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", "type": "object", "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." - }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" } }, "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" + "pull_request_comment_url" ] }, - "combined-billing-usage": { + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", "type": "object", "properties": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." - }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." - }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" } }, "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" + "pull_request_review_url" ] }, - "billing-usage-report": { + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", "type": "object", "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" } - } + }, + "required": [ + "pull_request_review_comment_url" + ] }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" }, - "login": { - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" }, - "display_login": { - "type": "string" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, - "gravatar_id": { - "type": "string", - "nullable": true + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" }, - "avatar_url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + ], + "nullable": true }, - "nullable-milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "organization-secret-scanning-alert": { "type": "object", "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "$ref": "#/components/schemas/alert-url" }, "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + "$ref": "#/components/schemas/alert-html-url" }, - "labels_url": { + "locations_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 + "description": "The REST API URL of the code locations for this alert." }, "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "$ref": "#/components/schemas/secret-scanning-alert-state" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" }, - "description": { + "resolved_at": { "type": "string", - "example": "Tracking milestone for version 1.0", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, - "creator": { + "resolved_by": { "$ref": "#/components/schemas/nullable-simple-user" }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { + "secret_type": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "description": "The type of secret that secret scanning detected." }, - "updated_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, - "closed_at": { + "secret": { "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", "nullable": true }, - "due_on": { + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", "format": "date-time", - "example": "2012-10-09T23:39:01Z", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "issue-type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "name": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "description": "The name of the issue type." + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "description": { + "push_protection_bypass_request_comment": { "type": "string", - "description": "The description of the issue type.", + "description": "An optional comment when requesting a push protection bypass.", "nullable": true }, - "color": { + "push_protection_bypass_request_html_url": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "format": "uri", + "description": "The URL to a push protection bypass request.", "nullable": true }, - "created_at": { + "resolution_comment": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "The comment that was optionally added when this alert was closed", + "nullable": true }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "nullable-integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { + "validity": { "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" ] }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true }, - "description": { - "type": "string", - "example": "The description of the app.", + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", "nullable": true }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + } + } + }, + "actions-billing-usage": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." }, - "permissions": { - "description": "The set of permissions for the GitHub app", + "minutes_used_breakdown": { "type": "object", "properties": { - "issues": { - "type": "string" + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." }, - "checks": { - "type": "string" + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." }, - "metadata": { - "type": "string" + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." }, - "contents": { - "type": "string" + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." }, - "deployments": { - "type": "string" + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" ] }, - "author-association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "advanced-security-active-committers-user": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" ] }, - "reaction-rollup": { - "title": "Reaction Rollup", + "advanced-security-active-committers-repository": { "type": "object", "properties": { - "url": { + "name": { "type": "string", - "format": "uri" + "example": "octocat/Hello-World" }, - "total_count": { - "type": "integer" + "advanced_security_committers": { + "type": "integer", + "example": 25 }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-user" + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + }, + "advanced-security-active-committers": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "example": 25 }, - "laugh": { - "type": "integer" + "total_count": { + "type": "integer", + "example": 2 }, - "confused": { - "type": "integer" + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" }, - "heart": { - "type": "integer" + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" }, - "hooray": { - "type": "integer" + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + } + } + }, + "required": [ + "repositories" + ] + }, + "get-all-cost-centers": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "packages-billing-usage": { + "type": "object", + "properties": { + "total_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." }, - "eyes": { - "type": "integer" + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." }, - "rocket": { - "type": "integer" + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" ] }, - "sub-issues-summary": { - "title": "Sub-issues Summary", + "combined-billing-usage": { "type": "object", "properties": { - "total": { - "type": "integer" + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." }, - "completed": { - "type": "integer" + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." }, - "percent_completed": { - "type": "integer" + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." } }, "required": [ - "total", - "completed", - "percent_completed" + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" ] }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, + "actor": { + "title": "Actor", + "description": "Actor", "type": "object", "properties": { "id": { - "type": "integer", - "format": "int64" + "type": "integer" }, - "node_id": { + "login": { "type": "string" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { + "display_login": { "type": "string" }, - "comments_url": { + "gravatar_id": { "type": "string", - "format": "uri" + "nullable": true }, - "events_url": { + "url": { "type": "string", "format": "uri" }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "labels_url": { "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned" - ] + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" + "id": { + "type": "integer", + "example": 1002604 }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "node_id": { "type": "string", - "nullable": true + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" + "default": "open" }, - "locked": { - "type": "boolean" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "active_lock_reason": { + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "comments": { - "type": "integer" + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "open_issues": { + "type": "integer", + "example": 4 }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "closed_issues": { + "type": "integer", + "example": 8 }, "created_at": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "timeline_url": { + "closed_at": { "type": "string", - "format": "uri" - }, - "type": { - "$ref": "#/components/schemas/issue-type" - }, - "repository": { - "$ref": "#/components/schemas/repository" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "sub_issues_summary": { - "$ref": "#/components/schemas/sub-issues-summary" + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ - "assignee", + "closed_issues", + "creator", + "description", + "due_on", "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", "labels_url", - "milestone", + "html_url", "number", - "repository_url", + "open_issues", "state", - "locked", "title", "url", - "user", - "author_association", "created_at", "updated_at" - ] + ], + "nullable": true }, - "issue-comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", - "format": "int64" + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" + "description": "The node identifier of the issue type." }, - "body_html": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the issue type." }, - "html_url": { + "description": { "type": "string", - "format": "uri" + "description": "The description of the issue type.", + "nullable": true }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "description": "The time the issue type created.", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" - }, - "performed_via_github_app": { - "$ref": "#/components/schemas/nullable-integration" + "description": "The time the issue type last updated.", + "format": "date-time" }, - "reactions": { - "$ref": "#/components/schemas/reaction-rollup" + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" + "name", + "description" ] }, - "event": { - "title": "Event", - "description": "Event", + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "type": { + "node_id": { "type": "string", - "nullable": true + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "actor": { - "$ref": "#/components/schemas/actor" + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" }, - "url": { - "type": "string", - "format": "uri" + { + "$ref": "#/components/schemas/enterprise" } - }, - "required": [ - "id", - "name", - "url" ] }, - "org": { - "$ref": "#/components/schemas/actor" + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" }, - "payload": { + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "action": { + "issues": { "type": "string" }, - "issue": { - "$ref": "#/components/schemas/issue" + "checks": { + "type": "string" }, - "comment": { - "$ref": "#/components/schemas/issue-comment" + "metadata": { + "type": "string" }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } - } - } + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "public": { - "type": "boolean" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] - }, - "link-with-type": { - "title": "Link With Type", - "description": "Hypermedia Link with Type", - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "href", - "type" + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "feed": { - "title": "Feed", - "description": "Feed", + "author-association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reaction-rollup": { + "title": "Reaction Rollup", "type": "object", "properties": { - "timeline_url": { + "url": { "type": "string", - "example": "https://github.com/timeline" + "format": "uri" }, - "user_url": { - "type": "string", - "example": "https://github.com/{user}" + "total_count": { + "type": "integer" }, - "current_user_public_url": { - "type": "string", - "example": "https://github.com/octocat" + "+1": { + "type": "integer" }, - "current_user_url": { - "type": "string", - "example": "https://github.com/octocat.private?token=abc123" + "-1": { + "type": "integer" }, - "current_user_actor_url": { - "type": "string", - "example": "https://github.com/octocat.private.actor?token=abc123" + "laugh": { + "type": "integer" }, - "current_user_organization_url": { - "type": "string", - "example": "https://github.com/octocat-org" + "confused": { + "type": "integer" }, - "current_user_organization_urls": { - "type": "array", - "example": [ - "https://github.com/organizations/github/octocat.private.atom?token=abc123" - ], - "items": { - "type": "string", - "format": "uri" - } + "heart": { + "type": "integer" }, - "security_advisories_url": { - "type": "string", - "example": "https://github.com/security-advisories" + "hooray": { + "type": "integer" }, - "repository_discussions_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions", - "description": "A feed of discussions for a given repository." + "eyes": { + "type": "integer" }, - "repository_discussions_category_url": { - "type": "string", - "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", - "description": "A feed of discussions for a given repository and category." + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "_links": { - "type": "object", - "properties": { - "timeline": { - "$ref": "#/components/schemas/link-with-type" - }, - "user": { - "$ref": "#/components/schemas/link-with-type" - }, - "security_advisories": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_public": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_actor": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organization": { - "$ref": "#/components/schemas/link-with-type" - }, - "current_user_organizations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "repository_discussions": { - "$ref": "#/components/schemas/link-with-type" - }, - "repository_discussions_category": { - "$ref": "#/components/schemas/link-with-type" - } - }, - "required": [ - "timeline", - "user" - ] + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" } }, "required": [ - "_links", - "timeline_url", - "user_url" + "total", + "completed", + "percent_completed" ] }, - "base-gist": { - "title": "Base Gist", - "description": "Base Gist", + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "id": { + "type": "integer", + "format": "int64" }, - "forks_url": { + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "commits_url": { + "repository_url": { "type": "string", "format": "uri" }, - "id": { - "type": "string" - }, - "node_id": { + "labels_url": { "type": "string" }, - "git_pull_url": { + "comments_url": { "type": "string", "format": "uri" }, - "git_push_url": { + "events_url": { "type": "string", "format": "uri" }, @@ -117476,510 +117266,524 @@ "type": "string", "format": "uri" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "encoding": { - "type": "string", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "utf-8" - } - } - } + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" }, - "public": { - "type": "boolean" + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" }, - "created_at": { + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", "type": "string", - "format": "date-time" + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned" + ] }, - "updated_at": { - "type": "string", - "format": "date-time" + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" }, - "description": { + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "history": { + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { "type": "array", - "items": {} + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", "user", - "files", + "author_association", "created_at", "updated_at" ] }, - "public-user": { - "title": "Public User", - "description": "Public User", + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, - "user_view_type": { - "type": "string" - }, "node_id": { "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "html_url": { - "type": "string", - "format": "uri" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "gists_url": { + "body_text": { "type": "string" }, - "starred_url": { + "body_html": { "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "updated_at": { "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "name": { + "issue_url": { "type": "string", - "nullable": true + "format": "uri" }, - "company": { - "type": "string", - "nullable": true + "author_association": { + "$ref": "#/components/schemas/author-association" }, - "blog": { - "type": "string", - "nullable": true + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" }, - "location": { - "type": "string", - "nullable": true - }, - "email": { - "type": "string", - "format": "email", - "nullable": true - }, - "notification_email": { - "type": "string", - "format": "email", - "nullable": true - }, - "hireable": { - "type": "boolean", - "nullable": true - }, - "bio": { - "type": "string", - "nullable": true + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" }, - "twitter_username": { + "type": { "type": "string", "nullable": true }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "actor": { + "$ref": "#/components/schemas/actor" }, - "plan": { + "repo": { "type": "object", "properties": { - "collaborators": { + "id": { "type": "integer" }, "name": { "type": "string" }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" + "url": { + "type": "string", + "format": "uri" } }, "required": [ - "collaborators", + "id", "name", - "space", - "private_repos" + "url" ] }, - "private_gists": { - "type": "integer", - "example": 1 - }, - "total_private_repos": { - "type": "integer", - "example": 2 + "org": { + "$ref": "#/components/schemas/actor" }, - "owned_private_repos": { - "type": "integer", - "example": 2 + "payload": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "comment": { + "$ref": "#/components/schemas/issue-comment" + }, + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + } }, - "disk_usage": { - "type": "integer", - "example": 1 + "public": { + "type": "boolean" }, - "collaborators": { - "type": "integer", - "example": 3 + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at" - ], - "additionalProperties": false + "actor", + "repo", + "payload", + "public", + "created_at" + ] }, - "gist-history": { - "title": "Gist History", - "description": "Gist History", + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", "type": "object", "properties": { - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "href": { + "type": "string" }, - "version": { + "type": { "type": "string" + } + }, + "required": [ + "href", + "type" + ] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" }, - "committed_at": { + "user_url": { "type": "string", - "format": "date-time" + "example": "https://github.com/{user}" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" + }, + "current_user_url": { + "type": "string", + "example": "https://github.com/octocat.private?token=abc123" + }, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { + "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "items": { + "type": "string", + "format": "uri" } }, - "url": { + "security_advisories_url": { "type": "string", - "format": "uri" - } - } - }, - "gist-simple": { - "title": "Gist Simple", - "description": "Gist Simple", - "type": "object", - "properties": { - "forks": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "user": { - "$ref": "#/components/schemas/public-user" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - } + "example": "https://github.com/security-advisories" }, - "history": { - "deprecated": true, - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/gist-history" - } + "repository_discussions_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions", + "description": "A feed of discussions for a given repository." }, - "fork_of": { - "nullable": true, - "title": "Gist", - "description": "Gist", + "repository_discussions_category_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", + "description": "A feed of discussions for a given repository and category." + }, + "_links": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "forks_url": { - "type": "string", - "format": "uri" + "timeline": { + "$ref": "#/components/schemas/link-with-type" }, - "commits_url": { - "type": "string", - "format": "uri" + "user": { + "$ref": "#/components/schemas/link-with-type" }, - "id": { - "type": "string" + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" }, - "node_id": { - "type": "string" + "current_user": { + "$ref": "#/components/schemas/link-with-type" }, - "git_pull_url": { - "type": "string", - "format": "uri" + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" }, - "git_push_url": { - "type": "string", - "format": "uri" + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" }, - "html_url": { - "type": "string", - "format": "uri" + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" }, - "files": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "filename": { - "type": "string" - }, - "type": { - "type": "string" - }, - "language": { - "type": "string" - }, - "raw_url": { - "type": "string" - }, - "size": { - "type": "integer" - } - } + "current_user_organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/link-with-type" } }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "description": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "comments_enabled": { - "type": "boolean" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "truncated": { - "type": "boolean" - }, - "forks": { - "type": "array", - "items": {} + "repository_discussions": { + "$ref": "#/components/schemas/link-with-type" }, - "history": { - "type": "array", - "items": {} + "repository_discussions_category": { + "$ref": "#/components/schemas/link-with-type" } }, "required": [ - "id", - "node_id", - "url", - "forks_url", - "commits_url", - "git_pull_url", - "git_push_url", - "html_url", - "comments_url", - "public", - "description", - "comments", - "user", - "files", - "created_at", - "updated_at" + "timeline", + "user" ] - }, + } + }, + "required": [ + "_links", + "timeline_url", + "user_url" + ] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri" }, "forks_url": { - "type": "string" + "type": "string", + "format": "uri" }, "commits_url": { - "type": "string" + "type": "string", + "format": "uri" }, "id": { "type": "string" @@ -117988,18 +117792,20 @@ "type": "string" }, "git_pull_url": { - "type": "string" + "type": "string", + "format": "uri" }, "git_push_url": { - "type": "string" + "type": "string", + "format": "uri" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri" }, "files": { "type": "object", "additionalProperties": { - "nullable": true, "type": "object", "properties": { "filename": { @@ -118017,12 +117823,6 @@ "size": { "type": "integer" }, - "truncated": { - "type": "boolean" - }, - "content": { - "type": "string" - }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", @@ -118035,10 +117835,12 @@ "type": "boolean" }, "created_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "updated_at": { - "type": "string" + "type": "string", + "format": "date-time" }, "description": { "type": "string", @@ -118051,460 +117853,985 @@ "type": "boolean" }, "user": { - "type": "string", - "nullable": true + "$ref": "#/components/schemas/nullable-simple-user" }, "comments_url": { - "type": "string" + "type": "string", + "format": "uri" }, "owner": { "$ref": "#/components/schemas/simple-user" }, "truncated": { "type": "boolean" - } - } - }, - "gist-comment": { - "title": "Gist Comment", - "description": "A comment made to a gist.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDExOkdpc3RDb21tZW50MQ==" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + "forks": { + "type": "array", + "items": {} }, - "body": { - "description": "The comment text.", - "type": "string", - "maxLength": 65535, - "example": "Body of the attachment" - }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-18T23:23:56Z" - }, - "author_association": { - "$ref": "#/components/schemas/author-association" + "history": { + "type": "array", + "items": {} } }, "required": [ - "url", "id", "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", "user", - "body", - "author_association", + "files", "created_at", "updated_at" ] }, - "gist-commit": { - "title": "Gist Commit", - "description": "Gist Commit", + "public-user": { + "title": "Public User", + "description": "Public User", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + "login": { + "type": "string" }, - "version": { - "type": "string", - "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + "id": { + "type": "integer", + "format": "int64" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "user_view_type": { + "type": "string" }, - "change_status": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - } - } + "node_id": { + "type": "string" }, - "committed_at": { - "type": "string", - "format": "date-time", - "example": "2010-04-14T02:15:15Z" - } - }, - "required": [ - "url", - "user", - "version", - "committed_at", - "change_status" - ] - }, - "gitignore-template": { - "title": "Gitignore Template", - "description": "Gitignore Template", - "type": "object", - "properties": { - "name": { + "avatar_url": { "type": "string", - "example": "C" + "format": "uri" }, - "source": { + "gravatar_id": { "type": "string", - "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" - } - }, - "required": [ - "name", - "source" - ] - }, - "license-simple": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { + "nullable": true + }, + "url": { "type": "string", - "example": "mit" + "format": "uri" }, - "name": { + "html_url": { "type": "string", - "example": "MIT License" + "format": "uri" }, - "url": { + "followers_url": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "format": "uri" }, - "spdx_id": { + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { "type": "string", - "nullable": true, - "example": "MIT" + "format": "uri" }, - "node_id": { + "organizations_url": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "format": "uri" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - }, - "license": { - "title": "License", - "description": "License", - "type": "object", - "properties": { - "key": { + }, + "events_url": { + "type": "string" + }, + "received_events_url": { "type": "string", - "example": "mit" + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" }, "name": { "type": "string", - "example": "MIT License" + "nullable": true }, - "spdx_id": { + "company": { "type": "string", - "example": "MIT", "nullable": true }, - "url": { + "blog": { "type": "string", - "format": "uri", - "example": "https://api.github.com/licenses/mit", "nullable": true }, - "node_id": { + "location": { "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "nullable": true }, - "html_url": { + "email": { "type": "string", - "format": "uri", - "example": "http://choosealicense.com/licenses/mit/" + "format": "email", + "nullable": true }, - "description": { + "notification_email": { "type": "string", - "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + "format": "email", + "nullable": true }, - "implementation": { + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { "type": "string", - "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + "nullable": true }, - "permissions": { - "type": "array", - "example": [ - "commercial-use", - "modifications", - "distribution", - "sublicense", - "private-use" - ], - "items": { - "type": "string" - } + "twitter_username": { + "type": "string", + "nullable": true }, - "conditions": { - "type": "array", - "example": [ - "include-copyright" - ], - "items": { - "type": "string" - } + "public_repos": { + "type": "integer" }, - "limitations": { - "type": "array", - "example": [ - "no-liability" - ], - "items": { - "type": "string" - } + "public_gists": { + "type": "integer" }, - "body": { + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { "type": "string", - "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + "format": "date-time" }, - "featured": { - "type": "boolean", - "example": true - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id", - "html_url", - "description", - "implementation", - "permissions", - "conditions", - "limitations", - "body", - "featured" - ] - }, - "marketplace-listing-plan": { - "title": "Marketplace Listing Plan", - "description": "Marketplace Listing Plan", - "type": "object", - "properties": { - "url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313" + "format": "date-time" }, - "accounts_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] }, - "id": { + "private_gists": { "type": "integer", - "example": 1313 + "example": 1 }, - "number": { + "total_private_repos": { "type": "integer", - "example": 3 - }, - "name": { - "type": "string", - "example": "Pro" - }, - "description": { - "type": "string", - "example": "A professional-grade CI solution" + "example": 2 }, - "monthly_price_in_cents": { + "owned_private_repos": { "type": "integer", - "example": 1099 + "example": 2 }, - "yearly_price_in_cents": { + "disk_usage": { "type": "integer", - "example": 11870 - }, - "price_model": { - "type": "string", - "enum": [ - "FREE", - "FLAT_RATE", - "PER_UNIT" - ], - "example": "FLAT_RATE" - }, - "has_free_trial": { - "type": "boolean", - "example": true - }, - "unit_name": { - "type": "string", - "nullable": true - }, - "state": { - "type": "string", - "example": "published" + "example": 1 }, - "bullets": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "Up to 25 private repositories", - "11 concurrent builds" - ] + "collaborators": { + "type": "integer", + "example": 3 } }, "required": [ - "url", - "accounts_url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "number", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", "name", - "description", - "has_free_trial", - "price_model", - "unit_name", - "monthly_price_in_cents", - "state", - "yearly_price_in_cents", - "bullets" - ] + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false }, - "marketplace-purchase": { - "title": "Marketplace Purchase", - "description": "Marketplace Purchase", + "gist-history": { + "title": "Gist History", + "description": "Gist History", "type": "object", "properties": { - "url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "organization_billing_email": { + "version": { "type": "string" }, - "email": { + "committed_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "marketplace_pending_change": { + "change_status": { "type": "object", "properties": { - "is_installed": { - "type": "boolean" - }, - "effective_date": { - "type": "string" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "id": { + "total": { "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" - } - }, - "nullable": true - }, - "marketplace_purchase": { - "type": "object", - "properties": { - "billing_cycle": { - "type": "string" - }, - "next_billing_date": { - "type": "string", - "nullable": true - }, - "is_installed": { - "type": "boolean" - }, - "unit_count": { - "type": "integer", - "nullable": true - }, - "on_free_trial": { - "type": "boolean" - }, - "free_trial_ends_on": { - "type": "string", - "nullable": true - }, - "updated_at": { - "type": "string" + "additions": { + "type": "integer" }, - "plan": { - "$ref": "#/components/schemas/marketplace-listing-plan" + "deletions": { + "type": "integer" } } + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "url", - "id", - "type", - "login", - "marketplace_purchase" - ] + } }, - "api-overview": { - "title": "Api Overview", - "description": "Api Overview", + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", "type": "object", "properties": { - "verifiable_password_authentication": { - "type": "boolean", - "example": true - }, - "ssh_key_fingerprints": { - "type": "object", - "properties": { + "forks": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/public-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "history": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-history" + } + }, + "fork_of": { + "nullable": true, + "title": "Gist", + "description": "Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + } + } + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": [ + "url", + "user", + "version", + "committed_at", + "change_status" + ] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "C" + }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": [ + "name", + "source" + ] + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "spdx_id": { + "type": "string", + "example": "MIT", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "example": [ + "include-copyright" + ], + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "example": [ + "no-liability" + ], + "items": { + "type": "string" + } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { + "type": "boolean", + "example": true + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { + "type": "integer", + "example": 1313 + }, + "number": { + "type": "integer", + "example": 3 + }, + "name": { + "type": "string", + "example": "Pro" + }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { + "type": "integer", + "example": 1099 + }, + "yearly_price_in_cents": { + "type": "integer", + "example": 11870 + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ], + "example": "FLAT_RATE" + }, + "has_free_trial": { + "type": "boolean", + "example": true + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "example": "published" + }, + "bullets": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "organization_billing_email": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true + }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { + "type": "boolean" + }, + "effective_date": { + "type": "string" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "id": { + "type": "integer" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { + "type": "string" + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "is_installed": { + "type": "boolean" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": [ + "url", + "id", + "type", + "login", + "marketplace_purchase" + ] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { "SHA256_RSA": { "type": "string" }, @@ -139396,27 +139723,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - }, - { - "$ref": "#/components/schemas/repository-rule-ruleset-info" - } - ] - }, - { - "allOf": [ - { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139426,7 +139733,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139436,7 +139743,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -139446,412 +139753,156 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] - } - ] - }, - "secret-scanning-alert": { - "type": "object", - "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/nullable-alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { - "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": "string", - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "resolved_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "resolution_comment": { - "type": "string", - "description": "An optional comment to resolve an alert.", - "nullable": true - }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "push_protection_bypassed": { - "type": "boolean", - "description": "Whether push protection was bypassed for the detected secret.", - "nullable": true - }, - "push_protection_bypassed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypassed_at": { - "type": "string", - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "push_protection_bypass_request_reviewer": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "push_protection_bypass_request_reviewer_comment": { - "type": "string", - "description": "An optional comment when reviewing a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_comment": { - "type": "string", - "description": "An optional comment when requesting a push protection bypass.", - "nullable": true - }, - "push_protection_bypass_request_html_url": { - "type": "string", - "format": "uri", - "description": "The URL to a push protection bypass request.", - "nullable": true - }, - "validity": { - "type": "string", - "description": "The token status as of the latest validity check.", - "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": "boolean", - "description": "Whether the detected secret was publicly leaked.", - "nullable": true - }, - "multi_repo": { - "type": "boolean", - "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", - "nullable": true - }, - "is_base64_encoded": { - "type": "boolean", - "description": "A boolean value representing whether or not alert is base64 encoded", - "nullable": true - } - } - }, - "secret-scanning-alert-resolution-comment": { - "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", - "type": "string", - "nullable": true - }, - "secret-scanning-location-commit": { - "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path in the repository", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-wiki-commit": { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - "secret-scanning-location-issue-title": { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } - }, - "required": [ - "issue_title_url" ] }, - "secret-scanning-location-issue-body": { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "secret-scanning-alert": { "type": "object", "properties": { - "issue_body_url": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { "type": "string", "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - "secret-scanning-location-issue-comment": { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - "secret-scanning-location-discussion-title": { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - "secret-scanning-location-discussion-body": { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - "secret-scanning-location-discussion-comment": { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - "secret-scanning-location-pull-request-title": { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - "secret-scanning-location-pull-request-body": { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - "secret-scanning-location-pull-request-comment": { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - "secret-scanning-location-pull-request-review": { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - "secret-scanning-location-pull-request-review-comment": { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { "type": "string", "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" } - }, - "required": [ - "pull_request_review_comment_url" - ] + } + }, + "secret-scanning-alert-resolution-comment": { + "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", + "type": "string", + "nullable": true }, "secret-scanning-location": { "type": "object", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index bfc6f64a56..c64bb395a0 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -84528,6 +84528,264 @@ components: - wont_fix - revoked - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true organization-secret-scanning-alert: type: object properties: @@ -84621,6 +84879,8 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" actions-billing-usage: type: object properties: @@ -102731,249 +102991,13 @@ components: description: A boolean value representing whether or not alert is base64 encoded nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" secret-scanning-alert-resolution-comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: