View Source GitHub.PullRequest (GitHub REST API Client v0.3.1)

Provides struct and types for a PullRequest

Link to this section Summary

Link to this section Types

@type minimal() :: %GitHub.PullRequest{
  __info__: map(),
  _links: term(),
  active_lock_reason: term(),
  additions: term(),
  assignee: term(),
  assignees: term(),
  author_association: term(),
  auto_merge: term(),
  base: GitHub.PullRequest.Base.minimal(),
  body: term(),
  changed_files: term(),
  closed_at: term(),
  comments: term(),
  comments_url: term(),
  commits: term(),
  commits_url: term(),
  created_at: term(),
  deletions: term(),
  diff_url: term(),
  draft: term(),
  head: GitHub.PullRequest.Head.minimal(),
  html_url: term(),
  id: integer(),
  issue_url: term(),
  labels: term(),
  locked: term(),
  maintainer_can_modify: term(),
  merge_commit_sha: term(),
  mergeable: term(),
  mergeable_state: term(),
  merged: term(),
  merged_at: term(),
  merged_by: term(),
  milestone: term(),
  node_id: term(),
  number: integer(),
  patch_url: term(),
  rebaseable: term(),
  requested_reviewers: term(),
  requested_teams: term(),
  review_comment_url: term(),
  review_comments: term(),
  review_comments_url: term(),
  state: term(),
  statuses_url: term(),
  title: term(),
  updated_at: term(),
  url: String.t(),
  user: term()
}
@type simple() :: %GitHub.PullRequest{
  __info__: map(),
  _links: GitHub.PullRequest.Links.simple(),
  active_lock_reason: String.t() | nil,
  additions: term(),
  assignee: GitHub.User.simple() | nil,
  assignees: [GitHub.User.simple()] | nil,
  author_association: String.t(),
  auto_merge: GitHub.AutoMerge.t() | nil,
  base: GitHub.PullRequest.Base.simple(),
  body: String.t() | nil,
  changed_files: term(),
  closed_at: DateTime.t() | nil,
  comments: term(),
  comments_url: String.t(),
  commits: term(),
  commits_url: String.t(),
  created_at: DateTime.t(),
  deletions: term(),
  diff_url: String.t(),
  draft: boolean() | nil,
  head: GitHub.PullRequest.Head.simple(),
  html_url: String.t(),
  id: integer(),
  issue_url: String.t(),
  labels: [GitHub.PullRequest.Labels.simple()],
  locked: boolean(),
  maintainer_can_modify: term(),
  merge_commit_sha: String.t() | nil,
  mergeable: term(),
  mergeable_state: term(),
  merged: term(),
  merged_at: DateTime.t() | nil,
  merged_by: term(),
  milestone: GitHub.Milestone.t() | nil,
  node_id: String.t(),
  number: integer(),
  patch_url: String.t(),
  rebaseable: term(),
  requested_reviewers: [GitHub.User.simple()] | nil,
  requested_teams: [GitHub.Team.t()] | nil,
  review_comment_url: String.t(),
  review_comments: term(),
  review_comments_url: String.t(),
  state: String.t(),
  statuses_url: String.t(),
  title: String.t(),
  updated_at: DateTime.t(),
  url: String.t(),
  user: GitHub.User.simple() | nil
}
@type t() :: %GitHub.PullRequest{
  __info__: map(),
  _links: GitHub.PullRequest.Links.t(),
  active_lock_reason: String.t() | nil,
  additions: integer(),
  assignee: GitHub.User.simple() | nil,
  assignees: [GitHub.User.simple()] | nil,
  author_association: String.t(),
  auto_merge: GitHub.AutoMerge.t() | nil,
  base: GitHub.PullRequest.Base.t(),
  body: String.t() | nil,
  changed_files: integer(),
  closed_at: DateTime.t() | nil,
  comments: integer(),
  comments_url: String.t(),
  commits: integer(),
  commits_url: String.t(),
  created_at: DateTime.t(),
  deletions: integer(),
  diff_url: String.t(),
  draft: boolean() | nil,
  head: GitHub.PullRequest.Head.t(),
  html_url: String.t(),
  id: integer(),
  issue_url: String.t(),
  labels: [GitHub.PullRequest.Labels.t()],
  locked: boolean(),
  maintainer_can_modify: boolean(),
  merge_commit_sha: String.t() | nil,
  mergeable: boolean() | nil,
  mergeable_state: String.t(),
  merged: boolean(),
  merged_at: DateTime.t() | nil,
  merged_by: GitHub.User.simple() | nil,
  milestone: GitHub.Milestone.t() | nil,
  node_id: String.t(),
  number: integer(),
  patch_url: String.t(),
  rebaseable: boolean() | nil,
  requested_reviewers: [GitHub.User.simple()] | nil,
  requested_teams: [GitHub.Team.simple()] | nil,
  review_comment_url: String.t(),
  review_comments: integer(),
  review_comments_url: String.t(),
  state: String.t(),
  statuses_url: String.t(),
  title: String.t(),
  updated_at: DateTime.t(),
  url: String.t(),
  user: GitHub.User.simple()
}