pub struct CodeScanningAlertCreated {
pub action: CodeScanningAlertCreatedAction,
pub alert: CodeScanningAlertCreatedAlert,
pub commit_oid: String,
pub installation: Option<InstallationLite>,
pub organization: Option<Organization>,
pub ref_: String,
pub repository: Repository,
pub sender: GithubOrg,
}
Expand description
CodeScanningAlertCreated
JSON schema
{
"title": "code_scanning_alert created event",
"type": "object",
"required": [
"action",
"alert",
"commit_oid",
"ref",
"repository",
"sender"
],
"properties": {
"action": {
"type": "string",
"enum": [
"created"
]
},
"alert": {
"description": "The code scanning alert involved in the event.",
"type": "object",
"required": [
"created_at",
"dismissed_at",
"dismissed_by",
"dismissed_reason",
"html_url",
"instances",
"number",
"rule",
"state",
"tool",
"url"
],
"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": "null"
},
"dismissed_by": {
"type": "null"
},
"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": "null"
},
"html_url": {
"description": "The GitHub URL of the alert resource.",
"type": "string",
"format": "uri"
},
"instances": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/alert-instance"
},
{
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"open",
"dismissed"
]
}
},
"tsAdditionalProperties": false
}
]
}
},
"most_recent_instance": {
"$ref": "#/definitions/alert-instance"
},
"number": {
"description": "The code scanning alert number.",
"type": "integer"
},
"rule": {
"type": "object",
"required": [
"description",
"id",
"severity"
],
"properties": {
"description": {
"description": "A short description of the rule used to detect the alert.",
"type": "string"
},
"full_description": {
"type": "string"
},
"help": {
"type": "null"
},
"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",
"null"
],
"enum": [
"none",
"note",
"warning",
"error",
null
]
},
"tags": {
"type": "null"
}
},
"additionalProperties": false
},
"state": {
"description": "State of a code scanning alert.",
"type": "string",
"enum": [
"open",
"dismissed"
]
},
"tool": {
"type": "object",
"required": [
"name",
"version"
],
"properties": {
"guid": {
"type": [
"string",
"null"
]
},
"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",
"null"
]
}
},
"additionalProperties": false
},
"url": {
"description": "The REST API URL of the alert resource.",
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"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"
},
"installation": {
"$ref": "#/definitions/installation-lite"
},
"organization": {
"$ref": "#/definitions/organization"
},
"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": {
"$ref": "#/definitions/repository"
},
"sender": {
"$ref": "#/definitions/github-org"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema"
}
Fields§
§action: CodeScanningAlertCreatedAction
§alert: CodeScanningAlertCreatedAlert
§commit_oid: String
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.
installation: Option<InstallationLite>
§organization: Option<Organization>
§ref_: String
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.
repository: Repository
§sender: GithubOrg
Implementations§
Source§impl CodeScanningAlertCreated
impl CodeScanningAlertCreated
pub fn builder() -> CodeScanningAlertCreated
Trait Implementations§
Source§impl Clone for CodeScanningAlertCreated
impl Clone for CodeScanningAlertCreated
Source§fn clone(&self) -> CodeScanningAlertCreated
fn clone(&self) -> CodeScanningAlertCreated
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for CodeScanningAlertCreated
impl Debug for CodeScanningAlertCreated
Source§impl<'de> Deserialize<'de> for CodeScanningAlertCreated
impl<'de> Deserialize<'de> for CodeScanningAlertCreated
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl From<&CodeScanningAlertCreated> for CodeScanningAlertCreated
impl From<&CodeScanningAlertCreated> for CodeScanningAlertCreated
Source§fn from(value: &CodeScanningAlertCreated) -> Self
fn from(value: &CodeScanningAlertCreated) -> Self
Converts to this type from the input type.
Source§impl From<CodeScanningAlertCreated> for CodeScanningAlertCreated
impl From<CodeScanningAlertCreated> for CodeScanningAlertCreated
Source§fn from(value: CodeScanningAlertCreated) -> Self
fn from(value: CodeScanningAlertCreated) -> Self
Converts to this type from the input type.
Source§impl From<CodeScanningAlertCreated> for CodeScanningAlertEvent
impl From<CodeScanningAlertCreated> for CodeScanningAlertEvent
Source§fn from(value: CodeScanningAlertCreated) -> Self
fn from(value: CodeScanningAlertCreated) -> Self
Converts to this type from the input type.
Source§impl Serialize for CodeScanningAlertCreated
impl Serialize for CodeScanningAlertCreated
Auto Trait Implementations§
impl Freeze for CodeScanningAlertCreated
impl RefUnwindSafe for CodeScanningAlertCreated
impl Send for CodeScanningAlertCreated
impl Sync for CodeScanningAlertCreated
impl Unpin for CodeScanningAlertCreated
impl UnwindSafe for CodeScanningAlertCreated
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more