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 1bdb18893..034293241 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 @@ -78558,6 +78558,99 @@ } } }, + "code-scanning-alert-updated-assignment": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "commit-comment-created": { "post": { "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", @@ -104664,6 +104757,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -155785,6 +155888,333 @@ "sender" ] }, + "webhook-code-scanning-alert-updated-assignment": { + "title": "code_scanning_alert updated_assignment event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated_assignment" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-commit-comment-created": { "title": "commit_comment created event", "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 41f67574a..7b36ef462 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 @@ -56858,6 +56858,70 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -75874,6 +75938,14 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -115358,6 +115430,261 @@ components: - commit_oid - repository - sender + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-commit-comment-created: title: commit_comment created event type: object diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 1bdb18893..034293241 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -78558,6 +78558,99 @@ } } }, + "code-scanning-alert-updated-assignment": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "commit-comment-created": { "post": { "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", @@ -104664,6 +104757,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -155785,6 +155888,333 @@ "sender" ] }, + "webhook-code-scanning-alert-updated-assignment": { + "title": "code_scanning_alert updated_assignment event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated_assignment" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-commit-comment-created": { "title": "commit_comment created event", "type": "object", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 41f67574a..7b36ef462 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -56858,6 +56858,70 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -75874,6 +75938,14 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -115358,6 +115430,261 @@ components: - commit_oid - repository - sender + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-commit-comment-created: title: commit_comment created event type: object 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 2ab99a8ee..532b02d6b 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 @@ -17370,6 +17370,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18040,6 +18050,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18503,6 +18523,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18905,618 +18935,638 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a custom code security configuration for an enterprise", - "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-enterprise-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique across the enterprise." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-enterprise recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -20341,6 +20391,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -93069,6 +93129,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -93786,6 +93856,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -94144,6 +94224,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -94809,663 +94899,683 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when a configuration is updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -96156,6 +96266,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -284094,6 +284214,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -703188,11 +703318,2069 @@ ] }, "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "nullable": true, + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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" + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "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" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-closed-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "code_scanning_alert closed_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", "enum": [ - "open", "dismissed", "fixed" ] @@ -703200,6 +705388,10 @@ "tool": { "type": "object", "properties": { + "guid": { + "type": "string", + "nullable": true + }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -703218,6 +705410,101 @@ "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ @@ -704774,11 +707061,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -704845,250 +707132,31 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert closed_by_user event", + "title": "code_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed_by_user" + "created" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "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" - ] - } - }, "created_at": { "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", + "nullable": true, "format": "date-time" }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -705097,15 +707165,8 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", - "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -705116,6 +707177,9 @@ "type": "string", "format": "uri" }, + "instances_url": { + "type": "string" + }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -705248,15 +707312,17 @@ ] }, "state": { - "description": "State of a code scanning alert.", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": "string", + "nullable": true, "enum": [ - "dismissed", - "fixed" + "open", + "dismissed" ] }, "tool": { "type": "object", + "nullable": true, "properties": { "guid": { "type": "string", @@ -705277,104 +707343,143 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "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" + ] + } } }, "required": [ @@ -706931,11 +709036,11 @@ } } }, - "code-scanning-alert-created": { + "code-scanning-alert-fixed": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -707002,228 +709107,19 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert created event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "fixed" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", - "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "type": "string", - "nullable": true, - "enum": [ - "open", - "dismissed" - ] - }, - "tool": { - "type": "object", - "nullable": true, - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "updated_at": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true - }, "assignees": { "type": "array", "items": { @@ -707350,6 +709246,307 @@ "url" ] } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ @@ -708906,11 +711103,11 @@ } } }, - "code-scanning-alert-fixed": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -708977,13 +711174,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "reopened" ] }, "alert": { @@ -709125,103 +711322,11 @@ "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": "string", - "nullable": true, - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -709230,15 +711335,9 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -709250,8 +711349,7 @@ "format": "uri" }, "instances_url": { - "type": "string", - "format": "uri" + "type": "string" }, "most_recent_instance": { "title": "Alert Instance", @@ -709389,6 +711487,8 @@ "nullable": true, "type": "string", "enum": [ + "open", + "dismissed", "fixed" ] }, @@ -709414,9 +711514,16 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true } }, "required": [ @@ -709434,7 +711541,8 @@ }, "commit_oid": { "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" + "type": "string", + "nullable": true }, "enterprise": { "title": "Enterprise", @@ -709600,7 +711708,8 @@ }, "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" + "type": "string", + "nullable": true }, "repository": { "title": "Repository", @@ -710973,11 +713082,11 @@ } } }, - "code-scanning-alert-reopened": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -711044,13 +713153,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "reopened_by_user" ] }, "alert": { @@ -711191,11 +713300,9 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", "nullable": true }, "dismissed_by": { - "type": "object", "nullable": true }, "dismissed_comment": { @@ -711206,7 +713313,6 @@ }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": "string", "nullable": true }, "fixed_at": { @@ -711218,9 +713324,6 @@ "type": "string", "format": "uri" }, - "instances_url": { - "type": "string" - }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -711307,25 +713410,10 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { - "type": "string" - }, "severity": { "description": "The severity of the alert.", "type": "string", @@ -711337,13 +713425,6 @@ "error", null ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } } }, "required": [ @@ -711358,17 +713439,12 @@ "type": "string", "enum": [ "open", - "dismissed", "fixed" ] }, "tool": { "type": "object", "properties": { - "guid": { - "type": "string", - "nullable": true - }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -711384,16 +713460,9 @@ "version" ] }, - "updated_at": { - "type": "string", - "nullable": true - }, "url": { "type": "string", "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true } }, "required": [ @@ -711411,8 +713480,7 @@ }, "commit_oid": { "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", - "nullable": true + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -711578,8 +713646,7 @@ }, "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 + "type": "string" }, "repository": { "title": "Repository", @@ -712952,11 +715019,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-updated-assignment": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -713023,13 +715090,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert updated_assignment event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "updated_assignment" ] }, "alert": { @@ -713170,10 +715237,104 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "type": "string", + "nullable": true, + "format": "date-time" }, "dismissed_by": { - "nullable": true + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "dismissed_comment": { "type": "string", @@ -713182,8 +715343,15 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -713309,6 +715477,7 @@ "type": "string", "enum": [ "open", + "dismissed", "fixed" ] }, @@ -713348,10 +715517,6 @@ "tool" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -713514,10 +715679,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", @@ -714863,8 +717024,6 @@ "required": [ "action", "alert", - "ref", - "commit_oid", "repository", "sender" ] 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 17c09791d..c4d1394e5 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 @@ -7288,6 +7288,15 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert + dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -114659,6 +114668,318 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: *4 + created_at: + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: *427 + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions + this includes the workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the + analysis was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect + the alert. + type: string + id: + description: A unique identifier for the rule used to detect + the alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts + found outside the default branch will return a `null` value + until they are dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code + scanning analysis alert. + type: string + version: + description: The version of the tool used to detect the + alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: *724 + installation: *725 + organization: *726 + repository: *727 + sender: *4 + required: + - action + - alert + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- 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 2ab99a8ee..532b02d6b 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -17370,6 +17370,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18040,6 +18050,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18503,6 +18523,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -18905,618 +18935,638 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a custom code security configuration for an enterprise", - "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-enterprise-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique across the enterprise." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-enterprise recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -20341,6 +20391,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -93069,6 +93129,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -93786,6 +93856,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -94144,6 +94224,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -94809,663 +94899,683 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when a configuration is updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -96156,6 +96266,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -284094,6 +284214,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -703188,11 +703318,2069 @@ ] }, "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "nullable": true, + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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" + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "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" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-closed-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "code_scanning_alert closed_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", "enum": [ - "open", "dismissed", "fixed" ] @@ -703200,6 +705388,10 @@ "tool": { "type": "object", "properties": { + "guid": { + "type": "string", + "nullable": true + }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -703218,6 +705410,101 @@ "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ @@ -704774,11 +707061,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -704845,250 +707132,31 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert closed_by_user event", + "title": "code_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed_by_user" + "created" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "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" - ] - } - }, "created_at": { "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", + "nullable": true, "format": "date-time" }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -705097,15 +707165,8 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", - "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -705116,6 +707177,9 @@ "type": "string", "format": "uri" }, + "instances_url": { + "type": "string" + }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -705248,15 +707312,17 @@ ] }, "state": { - "description": "State of a code scanning alert.", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": "string", + "nullable": true, "enum": [ - "dismissed", - "fixed" + "open", + "dismissed" ] }, "tool": { "type": "object", + "nullable": true, "properties": { "guid": { "type": "string", @@ -705277,104 +707343,143 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "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" + ] + } } }, "required": [ @@ -706931,11 +709036,11 @@ } } }, - "code-scanning-alert-created": { + "code-scanning-alert-fixed": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -707002,228 +709107,19 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert created event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "fixed" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", - "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "type": "string", - "nullable": true, - "enum": [ - "open", - "dismissed" - ] - }, - "tool": { - "type": "object", - "nullable": true, - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "updated_at": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true - }, "assignees": { "type": "array", "items": { @@ -707350,6 +709246,307 @@ "url" ] } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ @@ -708906,11 +711103,11 @@ } } }, - "code-scanning-alert-fixed": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -708977,13 +711174,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "reopened" ] }, "alert": { @@ -709125,103 +711322,11 @@ "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": "string", - "nullable": true, - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -709230,15 +711335,9 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -709250,8 +711349,7 @@ "format": "uri" }, "instances_url": { - "type": "string", - "format": "uri" + "type": "string" }, "most_recent_instance": { "title": "Alert Instance", @@ -709389,6 +711487,8 @@ "nullable": true, "type": "string", "enum": [ + "open", + "dismissed", "fixed" ] }, @@ -709414,9 +711514,16 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true } }, "required": [ @@ -709434,7 +711541,8 @@ }, "commit_oid": { "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" + "type": "string", + "nullable": true }, "enterprise": { "title": "Enterprise", @@ -709600,7 +711708,8 @@ }, "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" + "type": "string", + "nullable": true }, "repository": { "title": "Repository", @@ -710973,11 +713082,11 @@ } } }, - "code-scanning-alert-reopened": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -711044,13 +713153,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "reopened_by_user" ] }, "alert": { @@ -711191,11 +713300,9 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", "nullable": true }, "dismissed_by": { - "type": "object", "nullable": true }, "dismissed_comment": { @@ -711206,7 +713313,6 @@ }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": "string", "nullable": true }, "fixed_at": { @@ -711218,9 +713324,6 @@ "type": "string", "format": "uri" }, - "instances_url": { - "type": "string" - }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -711307,25 +713410,10 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { - "type": "string" - }, "severity": { "description": "The severity of the alert.", "type": "string", @@ -711337,13 +713425,6 @@ "error", null ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } } }, "required": [ @@ -711358,17 +713439,12 @@ "type": "string", "enum": [ "open", - "dismissed", "fixed" ] }, "tool": { "type": "object", "properties": { - "guid": { - "type": "string", - "nullable": true - }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -711384,16 +713460,9 @@ "version" ] }, - "updated_at": { - "type": "string", - "nullable": true - }, "url": { "type": "string", "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true } }, "required": [ @@ -711411,8 +713480,7 @@ }, "commit_oid": { "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", - "nullable": true + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -711578,8 +713646,7 @@ }, "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 + "type": "string" }, "repository": { "title": "Repository", @@ -712952,11 +715019,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-updated-assignment": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -713023,13 +715090,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert updated_assignment event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "updated_assignment" ] }, "alert": { @@ -713170,10 +715237,104 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "type": "string", + "nullable": true, + "format": "date-time" }, "dismissed_by": { - "nullable": true + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "dismissed_comment": { "type": "string", @@ -713182,8 +715343,15 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -713309,6 +715477,7 @@ "type": "string", "enum": [ "open", + "dismissed", "fixed" ] }, @@ -713348,10 +715517,6 @@ "tool" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", @@ -713514,10 +715679,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", @@ -714863,8 +717024,6 @@ "required": [ "action", "alert", - "ref", - "commit_oid", "repository", "sender" ] 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 17c09791d..c4d1394e5 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -7288,6 +7288,15 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert + dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -114659,6 +114668,318 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: *4 + created_at: + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: *427 + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions + this includes the workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the + analysis was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect + the alert. + type: string + id: + description: A unique identifier for the rule used to detect + the alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts + found outside the default branch will return a `null` value + until they are dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code + scanning analysis alert. + type: string + version: + description: The version of the tool used to detect the + alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: *724 + installation: *725 + organization: *726 + repository: *727 + sender: *4 + required: + - action + - alert + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 608fcbce0..023df6d68 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -36177,6 +36177,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -36847,6 +36857,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -37310,6 +37330,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -37712,618 +37742,638 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a custom code security configuration for an enterprise", - "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-enterprise-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique across the enterprise." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-enterprise recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -39148,6 +39198,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -137570,6 +137630,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -138287,6 +138357,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -138645,6 +138725,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -139310,663 +139400,683 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when a configuration is updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -140657,6 +140767,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -338660,6 +338780,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -781806,11 +781936,2069 @@ ] }, "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "nullable": true, + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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" + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "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" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-closed-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "code_scanning_alert closed_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", "enum": [ - "open", "dismissed", "fixed" ] @@ -781818,6 +784006,10 @@ "tool": { "type": "object", "properties": { + "guid": { + "type": "string", + "nullable": true + }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -781836,6 +784028,101 @@ "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ @@ -783392,11 +785679,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -783463,250 +785750,31 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert closed_by_user event", + "title": "code_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed_by_user" + "created" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "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" - ] - } - }, "created_at": { "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", + "nullable": true, "format": "date-time" }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -783715,15 +785783,8 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", - "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -783734,6 +785795,9 @@ "type": "string", "format": "uri" }, + "instances_url": { + "type": "string" + }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -783866,15 +785930,17 @@ ] }, "state": { - "description": "State of a code scanning alert.", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": "string", + "nullable": true, "enum": [ - "dismissed", - "fixed" + "open", + "dismissed" ] }, "tool": { "type": "object", + "nullable": true, "properties": { "guid": { "type": "string", @@ -783895,104 +785961,143 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "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" + ] + } } }, "required": [ @@ -785549,11 +787654,11 @@ } } }, - "code-scanning-alert-created": { + "code-scanning-alert-fixed": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -785620,228 +787725,19 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert created event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "fixed" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", - "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "type": "string", - "nullable": true, - "enum": [ - "open", - "dismissed" - ] - }, - "tool": { - "type": "object", - "nullable": true, - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "updated_at": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true - }, "assignees": { "type": "array", "items": { @@ -785968,6 +787864,307 @@ "url" ] } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ @@ -787524,11 +789721,11 @@ } } }, - "code-scanning-alert-fixed": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -787595,13 +789792,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "reopened" ] }, "alert": { @@ -787743,103 +789940,11 @@ "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": "string", - "nullable": true, - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -787848,15 +789953,9 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -787868,8 +789967,7 @@ "format": "uri" }, "instances_url": { - "type": "string", - "format": "uri" + "type": "string" }, "most_recent_instance": { "title": "Alert Instance", @@ -788007,6 +790105,8 @@ "nullable": true, "type": "string", "enum": [ + "open", + "dismissed", "fixed" ] }, @@ -788032,9 +790132,16 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true } }, "required": [ @@ -788052,7 +790159,8 @@ }, "commit_oid": { "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" + "type": "string", + "nullable": true }, "enterprise": { "title": "Enterprise", @@ -788218,7 +790326,8 @@ }, "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" + "type": "string", + "nullable": true }, "repository": { "title": "Repository", @@ -789591,11 +791700,11 @@ } } }, - "code-scanning-alert-reopened": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -789662,13 +791771,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "reopened_by_user" ] }, "alert": { @@ -789809,11 +791918,9 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", "nullable": true }, "dismissed_by": { - "type": "object", "nullable": true }, "dismissed_comment": { @@ -789824,7 +791931,6 @@ }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": "string", "nullable": true }, "fixed_at": { @@ -789836,9 +791942,6 @@ "type": "string", "format": "uri" }, - "instances_url": { - "type": "string" - }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -789925,25 +792028,10 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { - "type": "string" - }, "severity": { "description": "The severity of the alert.", "type": "string", @@ -789955,13 +792043,6 @@ "error", null ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } } }, "required": [ @@ -789976,17 +792057,12 @@ "type": "string", "enum": [ "open", - "dismissed", "fixed" ] }, "tool": { "type": "object", "properties": { - "guid": { - "type": "string", - "nullable": true - }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -790002,16 +792078,9 @@ "version" ] }, - "updated_at": { - "type": "string", - "nullable": true - }, "url": { "type": "string", "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true } }, "required": [ @@ -790029,8 +792098,7 @@ }, "commit_oid": { "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", - "nullable": true + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -790196,8 +792264,7 @@ }, "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 + "type": "string" }, "repository": { "title": "Repository", @@ -791570,11 +793637,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-updated-assignment": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -791641,13 +793708,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert updated_assignment event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "updated_assignment" ] }, "alert": { @@ -791788,10 +793855,104 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "type": "string", + "nullable": true, + "format": "date-time" }, "dismissed_by": { - "nullable": true + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "dismissed_comment": { "type": "string", @@ -791800,8 +793961,15 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -791927,6 +794095,7 @@ "type": "string", "enum": [ "open", + "dismissed", "fixed" ] }, @@ -791966,10 +794135,6 @@ "tool" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -792132,10 +794297,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", @@ -793481,8 +795642,6 @@ "required": [ "action", "alert", - "ref", - "commit_oid", "repository", "sender" ] diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 63a9b1c4c..88b4f1266 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -13937,6 +13937,15 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert + dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -130405,6 +130414,318 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: *4 + created_at: + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: *542 + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions + this includes the workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the + analysis was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect + the alert. + type: string + id: + description: A unique identifier for the rule used to detect + the alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts + found outside the default branch will return a `null` value + until they are dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code + scanning analysis alert. + type: string + version: + description: The version of the tool used to detect the + alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: *859 + installation: *860 + organization: *861 + repository: *862 + sender: *4 + required: + - action + - alert + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 608fcbce0..023df6d68 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -36177,6 +36177,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -36847,6 +36857,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -37310,6 +37330,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -37712,618 +37742,638 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a custom code security configuration for an enterprise", - "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-enterprise-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique across the enterprise." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-enterprise recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -39148,6 +39198,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -137570,6 +137630,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -138287,6 +138357,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -138645,6 +138725,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -139310,663 +139400,683 @@ "not_set" ] }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { + "dependabot_delegated_alert_dismissal": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/update-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example for updating a code security configuration", - "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response when a configuration is updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", "enum": [ "enabled", "disabled", @@ -140657,6 +140767,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -338660,6 +338780,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -781806,11 +781936,2069 @@ ] }, "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "nullable": true, + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "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": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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" + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "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" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-closed-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "code_scanning_alert closed_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "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" + ] + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", "type": "string", "enum": [ - "open", "dismissed", "fixed" ] @@ -781818,6 +784006,10 @@ "tool": { "type": "object", "properties": { + "guid": { + "type": "string", + "nullable": true + }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -781836,6 +784028,101 @@ "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] } }, "required": [ @@ -783392,11 +785679,11 @@ } } }, - "code-scanning-alert-closed-by-user": { + "code-scanning-alert-created": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -783463,250 +785750,31 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert closed_by_user event", + "title": "code_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "closed_by_user" + "created" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "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" - ] - } - }, "created_at": { "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", "type": "string", + "nullable": true, "format": "date-time" }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -783715,15 +785783,8 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", - "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -783734,6 +785795,9 @@ "type": "string", "format": "uri" }, + "instances_url": { + "type": "string" + }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -783866,15 +785930,17 @@ ] }, "state": { - "description": "State of a code scanning alert.", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": "string", + "nullable": true, "enum": [ - "dismissed", - "fixed" + "open", + "dismissed" ] }, "tool": { "type": "object", + "nullable": true, "properties": { "guid": { "type": "string", @@ -783895,104 +785961,143 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { - "title": "User", - "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "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" + ] + } } }, "required": [ @@ -785549,11 +787654,11 @@ } } }, - "code-scanning-alert-created": { + "code-scanning-alert-fixed": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -785620,228 +787725,19 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert created event", + "title": "code_scanning_alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "fixed" ] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", - "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", - "type": "string", - "nullable": true, - "enum": [ - "open", - "dismissed" - ] - }, - "tool": { - "type": "object", - "nullable": true, - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "updated_at": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true - }, "assignees": { "type": "array", "items": { @@ -785968,6 +787864,307 @@ "url" ] } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" } }, "required": [ @@ -787524,11 +789721,11 @@ } } }, - "code-scanning-alert-fixed": { + "code-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -787595,13 +789792,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert fixed event", + "title": "code_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "fixed" + "reopened" ] }, "alert": { @@ -787743,103 +789940,11 @@ "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": "string", - "nullable": true, - "format": "date-time" + "nullable": true }, "dismissed_by": { - "title": "User", "type": "object", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] + "nullable": true }, "dismissed_comment": { "type": "string", @@ -787848,15 +789953,9 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "type": "string", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests", - null - ] + "nullable": true }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -787868,8 +789967,7 @@ "format": "uri" }, "instances_url": { - "type": "string", - "format": "uri" + "type": "string" }, "most_recent_instance": { "title": "Alert Instance", @@ -788007,6 +790105,8 @@ "nullable": true, "type": "string", "enum": [ + "open", + "dismissed", "fixed" ] }, @@ -788032,9 +790132,16 @@ "version" ] }, + "updated_at": { + "type": "string", + "nullable": true + }, "url": { "type": "string", "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true } }, "required": [ @@ -788052,7 +790159,8 @@ }, "commit_oid": { "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" + "type": "string", + "nullable": true }, "enterprise": { "title": "Enterprise", @@ -788218,7 +790326,8 @@ }, "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" + "type": "string", + "nullable": true }, "repository": { "title": "Repository", @@ -789591,11 +791700,11 @@ } } }, - "code-scanning-alert-reopened": { + "code-scanning-alert-reopened-by-user": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -789662,13 +791771,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened event", + "title": "code_scanning_alert reopened_by_user event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "reopened_by_user" ] }, "alert": { @@ -789809,11 +791918,9 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string", "nullable": true }, "dismissed_by": { - "type": "object", "nullable": true }, "dismissed_comment": { @@ -789824,7 +791931,6 @@ }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "type": "string", "nullable": true }, "fixed_at": { @@ -789836,9 +791942,6 @@ "type": "string", "format": "uri" }, - "instances_url": { - "type": "string" - }, "most_recent_instance": { "title": "Alert Instance", "type": "object", @@ -789925,25 +792028,10 @@ "description": "A short description of the rule used to detect the alert.", "type": "string" }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, "id": { "description": "A unique identifier for the rule used to detect the alert.", "type": "string" }, - "name": { - "type": "string" - }, "severity": { "description": "The severity of the alert.", "type": "string", @@ -789955,13 +792043,6 @@ "error", null ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } } }, "required": [ @@ -789976,17 +792057,12 @@ "type": "string", "enum": [ "open", - "dismissed", "fixed" ] }, "tool": { "type": "object", "properties": { - "guid": { - "type": "string", - "nullable": true - }, "name": { "description": "The name of the tool used to generate the code scanning analysis alert.", "type": "string" @@ -790002,16 +792078,9 @@ "version" ] }, - "updated_at": { - "type": "string", - "nullable": true - }, "url": { "type": "string", "format": "uri" - }, - "dismissal_approved_by": { - "nullable": true } }, "required": [ @@ -790029,8 +792098,7 @@ }, "commit_oid": { "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", - "nullable": true + "type": "string" }, "enterprise": { "title": "Enterprise", @@ -790196,8 +792264,7 @@ }, "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 + "type": "string" }, "repository": { "title": "Repository", @@ -791570,11 +793637,11 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "code-scanning-alert-updated-assignment": { "post": { "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, @@ -791641,13 +793708,13 @@ "content": { "application/json": { "schema": { - "title": "code_scanning_alert reopened_by_user event", + "title": "code_scanning_alert updated_assignment event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened_by_user" + "updated_assignment" ] }, "alert": { @@ -791788,10 +793855,104 @@ }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true + "type": "string", + "nullable": true, + "format": "date-time" }, "dismissed_by": { - "nullable": true + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] }, "dismissed_comment": { "type": "string", @@ -791800,8 +793961,15 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -791927,6 +794095,7 @@ "type": "string", "enum": [ "open", + "dismissed", "fixed" ] }, @@ -791966,10 +794135,6 @@ "tool" ] }, - "commit_oid": { - "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": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -792132,10 +794297,6 @@ "description" ] }, - "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" - }, "repository": { "title": "Repository", "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", @@ -793481,8 +795642,6 @@ "required": [ "action", "alert", - "ref", - "commit_oid", "repository", "sender" ] diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 63a9b1c4c..88b4f1266 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -13937,6 +13937,15 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert + dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -130405,6 +130414,318 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: *4 + created_at: + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: *542 + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions + this includes the workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the + analysis was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect + the alert. + type: string + id: + description: A unique identifier for the rule used to detect + the alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts + found outside the default branch will return a `null` value + until they are dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code + scanning analysis alert. + type: string + version: + description: The version of the tool used to detect the + alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: *859 + installation: *860 + organization: *861 + repository: *862 + sender: *4 + required: + - action + - alert + - repository + - sender + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 3a5784975..9a172fc93 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -94038,6 +94038,99 @@ } } }, + "code-scanning-alert-updated-assignment": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "commit-comment-created": { "post": { "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", @@ -124793,6 +124886,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -178033,6 +178136,333 @@ "sender" ] }, + "webhook-code-scanning-alert-updated-assignment": { + "title": "code_scanning_alert updated_assignment event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated_assignment" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-commit-comment-created": { "title": "commit_comment created event", "type": "object", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 72c1bc327..d1829e203 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -67928,6 +67928,70 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -90479,6 +90543,14 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -131422,6 +131494,261 @@ components: - commit_oid - repository - sender + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-commit-comment-created: title: commit_comment created event type: object diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 3a5784975..9a172fc93 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -94038,6 +94038,99 @@ } } }, + "code-scanning-alert-updated-assignment": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "commit-comment-created": { "post": { "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", @@ -124793,6 +124886,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", @@ -178033,6 +178136,333 @@ "sender" ] }, + "webhook-code-scanning-alert-updated-assignment": { + "title": "code_scanning_alert updated_assignment event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated_assignment" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-commit-comment-created": { "title": "commit_comment created event", "type": "object", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 72c1bc327..d1829e203 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -67928,6 +67928,70 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -90479,6 +90543,14 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set code_scanning_options: type: object description: Feature options for code scanning @@ -131422,6 +131494,261 @@ components: - commit_oid - repository - sender + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-commit-comment-created: title: commit_comment created event type: object diff --git a/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json b/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json index dc9f04420..fe0cd5cb6 100644 --- a/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json +++ b/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.json @@ -40924,6 +40924,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -41476,6 +41486,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -41883,6 +41903,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -42211,6 +42241,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -42726,6 +42766,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -43488,6 +43538,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -120820,6 +120880,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -121411,6 +121481,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -121710,6 +121790,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -122299,6 +122389,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -122857,6 +122957,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -123482,6 +123592,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -274813,6 +274933,16 @@ "not_set" ] }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", diff --git a/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml b/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml index ac7a8b582..110721dc4 100644 --- a/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.17/dereferenced/ghes-3.17.2022-11-28.deref.yaml @@ -13787,6 +13787,15 @@ paths: - enabled {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}