Struct CodeScanningAlertClosedByUser

pub struct CodeScanningAlertClosedByUser {
    pub action: CodeScanningAlertClosedByUserAction,
    pub alert: CodeScanningAlertClosedByUserAlert,
    pub commit_oid: String,
    pub installation: Option<InstallationLite>,
    pub organization: Option<Organization>,
    pub ref_: String,
    pub repository: Repository,
    pub sender: User,
}

CodeScanningAlertClosedByUser

JSON schema

{
 "title": "code_scanning_alert closed_by_user event",
 "type": "object",
 "required": [
   "action",
   "alert",
   "commit_oid",
   "ref",
   "repository",
   "sender"
 ],
 "properties": {
   "action": {
     "type": "string",
     "enum": [
       "closed_by_user"
     ]
   },
   "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": "string",
         "format": "date-time"
       },
       "dismissed_by": {
         "$ref": "#/definitions/user"
       },
       "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": [
                     "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": [
           "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/user"
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

action: CodeScanningAlertClosedByUserAction

alert: CodeScanningAlertClosedByUserAlert

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: User

Implementations

impl CodeScanningAlertClosedByUser

pub fn builder() -> CodeScanningAlertClosedByUser

Trait Implementations

impl Clone for CodeScanningAlertClosedByUser

fn clone(&self) -> CodeScanningAlertClosedByUser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeScanningAlertClosedByUser

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeScanningAlertClosedByUser

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CodeScanningAlertClosedByUser> for CodeScanningAlertClosedByUser

fn from(value: &CodeScanningAlertClosedByUser) -> Self

Converts to this type from the input type.

impl From<CodeScanningAlertClosedByUser> for CodeScanningAlertClosedByUser

fn from(value: CodeScanningAlertClosedByUser) -> Self

Converts to this type from the input type.

impl From<CodeScanningAlertClosedByUser> for CodeScanningAlertEvent

fn from(value: CodeScanningAlertClosedByUser) -> Self

Converts to this type from the input type.

impl Serialize for CodeScanningAlertClosedByUser

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CodeScanningAlertClosedByUser> for CodeScanningAlertClosedByUser

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.