wip

google · Sep 1, 2024 · 225cebc · 225cebc
1 parent ea83389
commit 225cebc
Showing 1 changed file with 18 additions and 16 deletions.
diff --git a/github/event_types.go b/github/event_types.go
@@ -230,25 +230,27 @@ type DeploymentProtectionRuleEvent struct {
 //
 // GitHub API docs: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads?#deployment_review
 type DeploymentReviewEvent struct {
-	Action  *string `json:"action,omitempty"`
-	Comment *string `json:"comment,omitempty"`
-	// requester only populated when requested.
-	Requester *User `json:"requester,omitempty"`
-	// approver only populated when approved or rejected.
-	Approver *User `json:"approver,omitempty"`
+	// The action performed. Possible values are: "requested", "approved", or "rejected".
+	Action *string `json:"action,omitempty"`
 
+	// The following will be populated only if requested.
+	Requester   *User   `json:"requester,omitempty"`
 	Environment *string `json:"environment,omitempty"`
 
-	Enterprise      *Enterprise         `json:"enterprise,omitempty"`
-	Installation    *Installation       `json:"installation,omitempty"`
-	Organization    *Organization       `json:"organization,omitempty"`
-	Repo            *Repository         `json:"repository,omitempty"`
-	Reviewers       []*RequiredReviewer `json:"reviewers,omitempty"`
-	Sender          *User               `json:"sender,omitempty"`
-	Since           *string             `json:"since,omitempty"`
-	WorkflowJobRun  *WorkflowJobRun     `json:"workflow_job_run,omitempty"`
-	WorkflowJobRuns []*WorkflowJobRun   `json:"workflow_job_runs,omitempty"`
-	WorkflowRun     *WorkflowRun        `json:"workflow_run,omitempty"`
+	// The following will be populated only if approved or rejected.
+	Approver        *User             `json:"approver,omitempty"`
+	Comment         *string           `json:"comment,omitempty"`
+	WorkflowJobRuns []*WorkflowJobRun `json:"workflow_job_runs,omitempty"`
+
+	Enterprise     *Enterprise         `json:"enterprise,omitempty"`
+	Installation   *Installation       `json:"installation,omitempty"`
+	Organization   *Organization       `json:"organization,omitempty"`
+	Repo           *Repository         `json:"repository,omitempty"`
+	Reviewers      []*RequiredReviewer `json:"reviewers,omitempty"`
+	Sender         *User               `json:"sender,omitempty"`
+	Since          *string             `json:"since,omitempty"`
+	WorkflowJobRun *WorkflowJobRun     `json:"workflow_job_run,omitempty"`
+	WorkflowRun    *WorkflowRun        `json:"workflow_run,omitempty"`
 }
 
 // WorkflowJobRun represents a workflow_job_run in a GitHub DeploymentReviewEvent.