Struct CheckRunCreatedCheckRun

Source

pub struct CheckRunCreatedCheckRun {Show 17 fields
    pub app: App,
    pub check_suite: CheckRunCreatedCheckRunCheckSuite,
    pub completed_at: Option<DateTime<Utc>>,
    pub conclusion: Option<CheckRunCreatedCheckRunConclusion>,
    pub deployment: Option<CheckRunDeployment>,
    pub details_url: Option<String>,
    pub external_id: String,
    pub head_sha: String,
    pub html_url: String,
    pub id: i64,
    pub name: String,
    pub node_id: Option<String>,
    pub output: CheckRunCreatedCheckRunOutput,
    pub pull_requests: Vec<CheckRunPullRequest>,
    pub started_at: DateTime<Utc>,
    pub status: CheckRunCreatedCheckRunStatus,
    pub url: String,
}

Expand description

The check_run.

JSON schema

{
 "description": "The [check_run](https://docs.github.com/en/rest/reference/checks#get-a-check-run).",
 "type": "object",
 "required": [
   "app",
   "check_suite",
   "completed_at",
   "conclusion",
   "external_id",
   "head_sha",
   "html_url",
   "id",
   "name",
   "output",
   "pull_requests",
   "started_at",
   "status",
   "url"
 ],
 "properties": {
   "app": {
     "$ref": "#/definitions/app"
   },
   "check_suite": {
     "type": "object",
     "required": [
       "after",
       "app",
       "before",
       "conclusion",
       "created_at",
       "head_branch",
       "head_sha",
       "id",
       "pull_requests",
       "status",
       "updated_at",
       "url"
     ],
     "properties": {
       "after": {
         "type": [
           "string",
           "null"
         ]
       },
       "app": {
         "$ref": "#/definitions/app"
       },
       "before": {
         "type": [
           "string",
           "null"
         ]
       },
       "conclusion": {
         "type": [
           "string",
           "null"
         ],
         "enum": [
           "success",
           "failure",
           "neutral",
           "cancelled",
           "timed_out",
           "action_required",
           "stale",
           null
         ]
       },
       "created_at": {
         "type": "string",
         "format": "date-time"
       },
       "deployment": {
         "$ref": "#/definitions/check-run-deployment"
       },
       "head_branch": {
         "type": [
           "string",
           "null"
         ]
       },
       "head_sha": {
         "description": "The SHA of the head commit that is being checked.",
         "type": "string"
       },
       "id": {
         "description": "The id of the check suite that this check run is part of.",
         "type": "integer"
       },
       "node_id": {
         "type": "string"
       },
       "pull_requests": {
         "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
         "type": "array",
         "items": {
           "$ref": "#/definitions/check-run-pull-request"
         }
       },
       "status": {
         "type": "string",
         "enum": [
           "queued",
           "in_progress",
           "completed"
         ]
       },
       "updated_at": {
         "type": "string",
         "format": "date-time"
       },
       "url": {
         "type": "string",
         "format": "uri"
       }
     },
     "additionalProperties": false
   },
   "completed_at": {
     "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
     "oneOf": [
       {
         "type": "string",
         "format": "date-time"
       },
       {
         "type": "null"
       }
     ]
   },
   "conclusion": {
     "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
     "type": [
       "string",
       "null"
     ],
     "enum": [
       "success",
       "failure",
       "neutral",
       "cancelled",
       "timed_out",
       "action_required",
       "stale",
       "skipped",
       null
     ]
   },
   "deployment": {
     "$ref": "#/definitions/check-run-deployment"
   },
   "details_url": {
     "type": "string",
     "format": "uri"
   },
   "external_id": {
     "type": "string"
   },
   "head_sha": {
     "description": "The SHA of the commit that is being checked.",
     "type": "string"
   },
   "html_url": {
     "type": "string",
     "format": "uri"
   },
   "id": {
     "description": "The id of the check.",
     "type": "integer"
   },
   "name": {
     "description": "The name of the check run.",
     "type": "string"
   },
   "node_id": {
     "type": "string"
   },
   "output": {
     "type": "object",
     "required": [
       "annotations_count",
       "annotations_url",
       "summary",
       "text"
     ],
     "properties": {
       "annotations_count": {
         "type": "integer"
       },
       "annotations_url": {
         "type": "string",
         "format": "uri"
       },
       "summary": {
         "type": [
           "string",
           "null"
         ]
       },
       "text": {
         "type": [
           "string",
           "null"
         ]
       },
       "title": {
         "type": [
           "string",
           "null"
         ]
       }
     },
     "additionalProperties": false
   },
   "pull_requests": {
     "type": "array",
     "items": {
       "$ref": "#/definitions/check-run-pull-request"
     }
   },
   "started_at": {
     "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
     "type": "string",
     "format": "date-time"
   },
   "status": {
     "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.",
     "type": "string",
     "enum": [
       "queued",
       "in_progress",
       "completed",
       "waiting"
     ]
   },
   "url": {
     "type": "string",
     "format": "uri"
   }
 },
 "additionalProperties": false
}

Fields§

§app: App§check_suite: CheckRunCreatedCheckRunCheckSuite§completed_at: Option<DateTime<Utc>>

The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

§conclusion: Option<CheckRunCreatedCheckRunConclusion>

The result of the completed check run. Can be one of success, failure, neutral, cancelled, timed_out, action_required or stale. This value will be null until the check run has completed.