Struct CodeScanningAlertFixedAlert

Source

pub struct CodeScanningAlertFixedAlert {Show 13 fields
    pub created_at: DateTime<Utc>,
    pub dismissed_at: Option<DateTime<Utc>>,
    pub dismissed_by: Option<User>,
    pub dismissed_reason: Option<CodeScanningAlertFixedAlertDismissedReason>,
    pub html_url: String,
    pub instances: Vec<CodeScanningAlertFixedAlertInstancesItem>,
    pub instances_url: Option<String>,
    pub most_recent_instance: Option<AlertInstance>,
    pub number: i64,
    pub rule: CodeScanningAlertFixedAlertRule,
    pub state: CodeScanningAlertFixedAlertState,
    pub tool: CodeScanningAlertFixedAlertTool,
    pub url: String,
}

Expand description

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": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "dismissed_by": {
     "oneOf": [
       {
         "$ref": "#/definitions/user"
       },
       {
         "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": [
       "string",
       "null"
     ],
     "enum": [
       "false positive",
       "won't fix",
       "used in tests",
       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": [
                 "fixed"
               ]
             }
           },
           "tsAdditionalProperties": false
         }
       ]
     }
   },
   "instances_url": {
     "type": "string",
     "format": "uri"
   },
   "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": [
       "fixed"
     ]
   },
   "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: Option<DateTime<Utc>>

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

§dismissed_by: Option<User>§dismissed_reason: Option<CodeScanningAlertFixedAlertDismissedReason>

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<CodeScanningAlertFixedAlertInstancesItem>§instances_url: Option<String>§most_recent_instance: Option<AlertInstance>§number: i64

The code scanning alert number.

§rule: CodeScanningAlertFixedAlertRule§state: CodeScanningAlertFixedAlertState

State of a code scanning alert.

§tool: CodeScanningAlertFixedAlertTool§url: String

The REST API URL of the alert resource.