Struct CodeScanningAlertCreatedAlert

pub struct CodeScanningAlertCreatedAlert {
    pub created_at: DateTime<Utc>,
    pub dismissed_at: (),
    pub dismissed_by: (),
    pub dismissed_reason: (),
    pub html_url: String,
    pub instances: Vec<CodeScanningAlertCreatedAlertInstancesItem>,
    pub most_recent_instance: Option<AlertInstance>,
    pub number: i64,
    pub rule: CodeScanningAlertCreatedAlertRule,
    pub state: CodeScanningAlertCreatedAlertState,
    pub tool: CodeScanningAlertCreatedAlertTool,
    pub url: String,
}

The code scanning alert involved in the event.

JSON schema

{
 "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
}

Fields

created_at: DateTime<Utc>

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dismissed_at: ()

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

dismissed_by: ()

dismissed_reason: ()

The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

html_url: String

The GitHub URL of the alert resource.

instances: Vec<CodeScanningAlertCreatedAlertInstancesItem>

most_recent_instance: Option<AlertInstance>

number: i64

The code scanning alert number.

rule: CodeScanningAlertCreatedAlertRule

state: CodeScanningAlertCreatedAlertState

State of a code scanning alert.

tool: CodeScanningAlertCreatedAlertTool

url: String

The REST API URL of the alert resource.

Implementations

impl CodeScanningAlertCreatedAlert

pub fn builder() -> CodeScanningAlertCreatedAlert

Trait Implementations

impl Clone for CodeScanningAlertCreatedAlert

fn clone(&self) -> CodeScanningAlertCreatedAlert

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodeScanningAlertCreatedAlert

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeScanningAlertCreatedAlert

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CodeScanningAlertCreatedAlert> for CodeScanningAlertCreatedAlert

fn from(value: &CodeScanningAlertCreatedAlert) -> Self

Converts to this type from the input type.

impl From<CodeScanningAlertCreatedAlert> for CodeScanningAlertCreatedAlert

fn from(value: CodeScanningAlertCreatedAlert) -> Self

Converts to this type from the input type.

impl Serialize for CodeScanningAlertCreatedAlert

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CodeScanningAlertCreatedAlert> for CodeScanningAlertCreatedAlert

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: CodeScanningAlertCreatedAlert) -> Result<Self, String>

Performs the conversion.