GitHubPullRequestModel

pydantic model safir.github.models.GitHubPullRequestModel

A Pydantic model for a GitHub Pull Request.

This is also the pull_request field inside the GitHubPullRequestEventModel.

https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request

Parameters:

data (Any)

Fields:

• draft (bool)

• head (safir.github.models.GitHubPullRequestHeadModel)

• html_url (pydantic.networks.HttpUrl)

• merged (bool)

• number (int)

• state (safir.github.models.GitHubPullState)

• title (str)

• user (safir.github.models.GitHubUserModel)

field draft: bool [Required]

True if the PR is a draft.

field head: GitHubPullRequestHeadModel [Required]

The last commit to the head branch of the PR.

field html_url: HttpUrl [Required]

Web URL of the PR.

field merged: bool [Required]

True if the PR is merged.

field number: int [Required]

Pull request number.

field state: GitHubPullState [Required]

Whether the PR is opened or closed.

field title: str [Required]

Title of the PR.

field user: GitHubUserModel [Required]

The user that opened the PR.