APIs.io Engineering Platform · Schema
code_scanning_alert closed_by_user event
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| action | string | |
| alert | object | The code scanning alert involved in the event. |
| commit_oid | object | |
| enterprise | object | |
| installation | object | |
| organization | object | |
| ref | object | |
| repository | object | |
| sender | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-code-scanning-alert-closed-by-user",
"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": {
"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"
}
},
"required": [
"login",
"id"
]
},
"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
]
},
"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/<branch name>`.",
"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": [
"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"
},
"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": {
"$ref": "#/components/schemas/webhooks_code_scanning_commit_oid"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"ref": {
"$ref": "#/components/schemas/webhooks_code_scanning_ref"
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user-webhooks"
}
},
"required": [
"action",
"alert",
"ref",
"commit_oid",
"repository",
"sender"
]
}