docs: Add clarifications for mergeable field in pull requests (#3396)

google · Jan 30, 2025 · cbe65f0 · cbe65f0
1 parent 7783310
commit cbe65f0
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 57 deletions.
diff --git a/github/github-stringify_test.go b/github/github-stringify_test.go
diff --git a/github/pulls.go b/github/pulls.go
@@ -28,49 +28,51 @@ type PullRequestAutoMerge struct {
 
 // PullRequest represents a GitHub pull request on a repository.
 type PullRequest struct {
-	ID                  *int64                `json:"id,omitempty"`
-	Number              *int                  `json:"number,omitempty"`
-	State               *string               `json:"state,omitempty"`
-	Locked              *bool                 `json:"locked,omitempty"`
-	Title               *string               `json:"title,omitempty"`
-	Body                *string               `json:"body,omitempty"`
-	CreatedAt           *Timestamp            `json:"created_at,omitempty"`
-	UpdatedAt           *Timestamp            `json:"updated_at,omitempty"`
-	ClosedAt            *Timestamp            `json:"closed_at,omitempty"`
-	MergedAt            *Timestamp            `json:"merged_at,omitempty"`
-	Labels              []*Label              `json:"labels,omitempty"`
-	User                *User                 `json:"user,omitempty"`
-	Draft               *bool                 `json:"draft,omitempty"`
-	Merged              *bool                 `json:"merged,omitempty"`
-	Mergeable           *bool                 `json:"mergeable,omitempty"`
-	MergeableState      *string               `json:"mergeable_state,omitempty"`
-	MergedBy            *User                 `json:"merged_by,omitempty"`
-	MergeCommitSHA      *string               `json:"merge_commit_sha,omitempty"`
-	Rebaseable          *bool                 `json:"rebaseable,omitempty"`
-	Comments            *int                  `json:"comments,omitempty"`
-	Commits             *int                  `json:"commits,omitempty"`
-	Additions           *int                  `json:"additions,omitempty"`
-	Deletions           *int                  `json:"deletions,omitempty"`
-	ChangedFiles        *int                  `json:"changed_files,omitempty"`
-	URL                 *string               `json:"url,omitempty"`
-	HTMLURL             *string               `json:"html_url,omitempty"`
-	IssueURL            *string               `json:"issue_url,omitempty"`
-	StatusesURL         *string               `json:"statuses_url,omitempty"`
-	DiffURL             *string               `json:"diff_url,omitempty"`
-	PatchURL            *string               `json:"patch_url,omitempty"`
-	CommitsURL          *string               `json:"commits_url,omitempty"`
-	CommentsURL         *string               `json:"comments_url,omitempty"`
-	ReviewCommentsURL   *string               `json:"review_comments_url,omitempty"`
-	ReviewCommentURL    *string               `json:"review_comment_url,omitempty"`
-	ReviewComments      *int                  `json:"review_comments,omitempty"`
-	Assignee            *User                 `json:"assignee,omitempty"`
-	Assignees           []*User               `json:"assignees,omitempty"`
-	Milestone           *Milestone            `json:"milestone,omitempty"`
-	MaintainerCanModify *bool                 `json:"maintainer_can_modify,omitempty"`
-	AuthorAssociation   *string               `json:"author_association,omitempty"`
-	NodeID              *string               `json:"node_id,omitempty"`
-	RequestedReviewers  []*User               `json:"requested_reviewers,omitempty"`
-	AutoMerge           *PullRequestAutoMerge `json:"auto_merge,omitempty"`
+	ID                 *int64                `json:"id,omitempty"`
+	Number             *int                  `json:"number,omitempty"`
+	State              *string               `json:"state,omitempty"`
+	Locked             *bool                 `json:"locked,omitempty"`
+	Title              *string               `json:"title,omitempty"`
+	Body               *string               `json:"body,omitempty"`
+	CreatedAt          *Timestamp            `json:"created_at,omitempty"`
+	UpdatedAt          *Timestamp            `json:"updated_at,omitempty"`
+	ClosedAt           *Timestamp            `json:"closed_at,omitempty"`
+	MergedAt           *Timestamp            `json:"merged_at,omitempty"`
+	Labels             []*Label              `json:"labels,omitempty"`
+	User               *User                 `json:"user,omitempty"`
+	Draft              *bool                 `json:"draft,omitempty"`
+	URL                *string               `json:"url,omitempty"`
+	HTMLURL            *string               `json:"html_url,omitempty"`
+	IssueURL           *string               `json:"issue_url,omitempty"`
+	StatusesURL        *string               `json:"statuses_url,omitempty"`
+	DiffURL            *string               `json:"diff_url,omitempty"`
+	PatchURL           *string               `json:"patch_url,omitempty"`
+	CommitsURL         *string               `json:"commits_url,omitempty"`
+	CommentsURL        *string               `json:"comments_url,omitempty"`
+	ReviewCommentsURL  *string               `json:"review_comments_url,omitempty"`
+	ReviewCommentURL   *string               `json:"review_comment_url,omitempty"`
+	Assignee           *User                 `json:"assignee,omitempty"`
+	Assignees          []*User               `json:"assignees,omitempty"`
+	Milestone          *Milestone            `json:"milestone,omitempty"`
+	AuthorAssociation  *string               `json:"author_association,omitempty"`
+	NodeID             *string               `json:"node_id,omitempty"`
+	RequestedReviewers []*User               `json:"requested_reviewers,omitempty"`
+	AutoMerge          *PullRequestAutoMerge `json:"auto_merge,omitempty"`
+
+	// These fields are not populated by the List operation.
+	Merged              *bool   `json:"merged,omitempty"`
+	Mergeable           *bool   `json:"mergeable,omitempty"`
+	MergeableState      *string `json:"mergeable_state,omitempty"`
+	Rebaseable          *bool   `json:"rebaseable,omitempty"`
+	MergedBy            *User   `json:"merged_by,omitempty"`
+	MergeCommitSHA      *string `json:"merge_commit_sha,omitempty"`
+	Comments            *int    `json:"comments,omitempty"`
+	Commits             *int    `json:"commits,omitempty"`
+	Additions           *int    `json:"additions,omitempty"`
+	Deletions           *int    `json:"deletions,omitempty"`
+	ChangedFiles        *int    `json:"changed_files,omitempty"`
+	MaintainerCanModify *bool   `json:"maintainer_can_modify,omitempty"`
+	ReviewComments      *int    `json:"review_comments,omitempty"`
 
 	// RequestedTeams is populated as part of the PullRequestEvent.
 	// See, https://docs.github.com/developers/webhooks-and-events/github-event-types#pullrequestevent for an example.