GitHubCheckSuiteModel

pydantic model safir.github.models.GitHubCheckSuiteModel

A Pydantic model for the check_suite field in a check_suite webhook (GitHubCheckSuiteEventModel).

Parameters:

data (Any)

Fields:

• conclusion (safir.github.models.GitHubCheckSuiteConclusion | None)

• head_branch (str)

• head_sha (str)

• id (int)

• pull_requests (list[safir.github.models.GitHubCheckRunPrInfoModel])

• status (safir.github.models.GitHubCheckSuiteStatus)

• url (pydantic.networks.HttpUrl)

field conclusion: Optional[GitHubCheckSuiteConclusion] [Required]

The conclusion of the check suite.

field head_branch: str [Required]

Name of the branch the changes are on.

field head_sha: str [Required]

The SHA of the most recent commit for this check suite.

field id: int [Required]

Identifier for this check run.

field pull_requests: list[GitHubCheckRunPrInfoModel] [Required]

A list of pull requests associated with this check suite.

field status: GitHubCheckSuiteStatus [Required]

The status of the check suite.

field url: HttpUrl [Required]

GitHub API URL for the check suite resource.