Fix: workflow_run pull_requests id/number types

mjpieters · mjpieters · commit ae008b9277cc · 2025-01-06T15:56:15.000Z
The webhook payload for the workflow_run event types (completed,
in-progress &amp; requested) each define the id and number of pull requests
as `number` where they clearly should be `integer` values.
diff --git a/githubkit/versions/ghec_v2022_11_28/models/group_0266.py b/githubkit/versions/ghec_v2022_11_28/models/group_0266.py
@@ -46,6 +46,13 @@ class CodeScanningDefaultSetup(GitHubModel):
             ]
         ]
     ] = Field(default=UNSET, description="Languages to be analyzed.")
+    runner_type: Missing[Union[None, Literal["standard", "labeled"]]] = Field(
+        default=UNSET, description="Runner type to be used."
+    )
+    runner_label: Missing[Union[str, None]] = Field(
+        default=UNSET,
+        description="Runner label to be used if the runner type is labeled.",
+    )
     query_suite: Missing[Literal["default", "extended"]] = Field(
         default=UNSET, description="CodeQL query suite to be used."
     )
diff --git a/githubkit/versions/ghec_v2022_11_28/models/group_0836.py b/githubkit/versions/ghec_v2022_11_28/models/group_0836.py
@@ -413,8 +413,8 @@ class WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItems(GitHubMode
     head: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/ghec_v2022_11_28/models/group_0837.py b/githubkit/versions/ghec_v2022_11_28/models/group_0837.py
@@ -402,8 +402,8 @@ class WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItems(GitHubMod
     head: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/ghec_v2022_11_28/models/group_0838.py b/githubkit/versions/ghec_v2022_11_28/models/group_0838.py
@@ -410,8 +410,8 @@ class WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItems(GitHubMode
     head: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/ghec_v2022_11_28/types/group_0266.py b/githubkit/versions/ghec_v2022_11_28/types/group_0266.py
@@ -38,6 +38,8 @@ class CodeScanningDefaultSetupType(TypedDict):
             ]
         ]
     ]
+    runner_type: NotRequired[Union[None, Literal["standard", "labeled"]]]
+    runner_label: NotRequired[Union[str, None]]
     query_suite: NotRequired[Literal["default", "extended"]]
     updated_at: NotRequired[Union[datetime, None]]
     schedule: NotRequired[Union[None, Literal["weekly"]]]
diff --git a/githubkit/versions/ghec_v2022_11_28/types/group_0836.py b/githubkit/versions/ghec_v2022_11_28/types/group_0836.py
@@ -368,8 +368,8 @@ class WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsType(TypedD
 
     base: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/githubkit/versions/ghec_v2022_11_28/types/group_0837.py b/githubkit/versions/ghec_v2022_11_28/types/group_0837.py
@@ -366,8 +366,8 @@ class WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsType(Typed
 
     base: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/githubkit/versions/ghec_v2022_11_28/types/group_0838.py b/githubkit/versions/ghec_v2022_11_28/types/group_0838.py
@@ -368,8 +368,8 @@ class WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsType(TypedD
 
     base: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/githubkit/versions/v2022_11_28/models/group_0229.py b/githubkit/versions/v2022_11_28/models/group_0229.py
@@ -46,6 +46,13 @@ class CodeScanningDefaultSetup(GitHubModel):
             ]
         ]
     ] = Field(default=UNSET, description="Languages to be analyzed.")
+    runner_type: Missing[Union[None, Literal["standard", "labeled"]]] = Field(
+        default=UNSET, description="Runner type to be used."
+    )
+    runner_label: Missing[Union[str, None]] = Field(
+        default=UNSET,
+        description="Runner label to be used if the runner type is labeled.",
+    )
     query_suite: Missing[Literal["default", "extended"]] = Field(
         default=UNSET, description="CodeQL query suite to be used."
     )
diff --git a/githubkit/versions/v2022_11_28/models/group_0778.py b/githubkit/versions/v2022_11_28/models/group_0778.py
@@ -413,8 +413,8 @@ class WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItems(GitHubMode
     head: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/v2022_11_28/models/group_0779.py b/githubkit/versions/v2022_11_28/models/group_0779.py
@@ -402,8 +402,8 @@ class WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItems(GitHubMod
     head: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/v2022_11_28/models/group_0780.py b/githubkit/versions/v2022_11_28/models/group_0780.py
@@ -410,8 +410,8 @@ class WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItems(GitHubMode
     head: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropHead = (
         Field()
     )
-    id: float = Field()
-    number: float = Field()
+    id: int = Field()
+    number: int = Field()
     url: str = Field()
 
 
diff --git a/githubkit/versions/v2022_11_28/types/group_0229.py b/githubkit/versions/v2022_11_28/types/group_0229.py
@@ -38,6 +38,8 @@ class CodeScanningDefaultSetupType(TypedDict):
             ]
         ]
     ]
+    runner_type: NotRequired[Union[None, Literal["standard", "labeled"]]]
+    runner_label: NotRequired[Union[str, None]]
     query_suite: NotRequired[Literal["default", "extended"]]
     updated_at: NotRequired[Union[datetime, None]]
     schedule: NotRequired[Union[None, Literal["weekly"]]]
diff --git a/githubkit/versions/v2022_11_28/types/group_0778.py b/githubkit/versions/v2022_11_28/types/group_0778.py
@@ -368,8 +368,8 @@ class WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsType(TypedD
 
     base: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/githubkit/versions/v2022_11_28/types/group_0779.py b/githubkit/versions/v2022_11_28/types/group_0779.py
@@ -366,8 +366,8 @@ class WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsType(Typed
 
     base: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/githubkit/versions/v2022_11_28/types/group_0780.py b/githubkit/versions/v2022_11_28/types/group_0780.py
@@ -368,8 +368,8 @@ class WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsType(TypedD
 
     base: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropBaseType
     head: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropHeadType
-    id: float
-    number: float
+    id: int
+    number: int
     url: str
 
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -472,6 +472,14 @@ source = "https://raw.githubusercontent.com/github/rest-api-description/main/des
   "null",
 ] }
 
+# webhook workflow run workflow-run-*.workflow_run.pull_requests.number and .id should be integers
+"/components/schemas/webhook-workflow-run-completed/properties/workflow_run/properties/pull_requests/items/properties/id" = { type = "integer" }
+"/components/schemas/webhook-workflow-run-completed/properties/workflow_run/properties/pull_requests/items/properties/number" = { type = "integer" }
+"/components/schemas/webhook-workflow-run-in-progress/properties/workflow_run/properties/pull_requests/items/properties/id" = { type = "integer" }
+"/components/schemas/webhook-workflow-run-in-progress/properties/workflow_run/properties/pull_requests/items/properties/number" = { type = "integer" }
+"/components/schemas/webhook-workflow-run-requested/properties/workflow_run/properties/pull_requests/items/properties/id" = { type = "integer" }
+"/components/schemas/webhook-workflow-run-requested/properties/workflow_run/properties/pull_requests/items/properties/number" = { type = "integer" }
+
 # webhook repository dispatch action can be any string
 "/webhooks/repository-dispatch-sample.collected/post" = { operationId = "repository-dispatch" }
 # "/components/schemas/webhook-repository-dispatch-sample/properties/action" = { enum = "<unset>" }

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,13 @@ class CodeScanningDefaultSetup(GitHubModel):`
`46`	`46`	`]`
`47`	`47`	`]`
`48`	`48`	`] = Field(default=UNSET, description="Languages to be analyzed.")`
	`49`	`+ runner_type: Missing[Union[None, Literal["standard", "labeled"]]] = Field(`
	`50`	`+ default=UNSET, description="Runner type to be used."`
	`51`	`+ )`
	`52`	`+ runner_label: Missing[Union[str, None]] = Field(`
	`53`	`+ default=UNSET,`
	`54`	`+ description="Runner label to be used if the runner type is labeled.",`
	`55`	`+ )`
`49`	`56`	`query_suite: Missing[Literal["default", "extended"]] = Field(`
`50`	`57`	`default=UNSET, description="CodeQL query suite to be used."`
`51`	`58`	`)`
Original file line number	Diff line number	Diff line change
`@@ -413,8 +413,8 @@ class WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItems(GitHubMode`
`413`	`413`	`head: WebhookWorkflowRunCompletedPropWorkflowRunPropPullRequestsItemsPropHead = (`
`414`	`414`	`Field()`
`415`	`415`	`)`
`416`		`- id: float = Field()`
`417`		`- number: float = Field()`
	`416`	`+ id: int = Field()`
	`417`	`+ number: int = Field()`
`418`	`418`	`url: str = Field()`
`419`	`419`
`420`	`420`
Original file line number	Diff line number	Diff line change
`@@ -402,8 +402,8 @@ class WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItems(GitHubMod`
`402`	`402`	`head: WebhookWorkflowRunInProgressPropWorkflowRunPropPullRequestsItemsPropHead = (`
`403`	`403`	`Field()`
`404`	`404`	`)`
`405`		`- id: float = Field()`
`406`		`- number: float = Field()`
	`405`	`+ id: int = Field()`
	`406`	`+ number: int = Field()`
`407`	`407`	`url: str = Field()`
`408`	`408`
`409`	`409`
Original file line number	Diff line number	Diff line change
`@@ -410,8 +410,8 @@ class WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItems(GitHubMode`
`410`	`410`	`head: WebhookWorkflowRunRequestedPropWorkflowRunPropPullRequestsItemsPropHead = (`
`411`	`411`	`Field()`
`412`	`412`	`)`
`413`		`- id: float = Field()`
`414`		`- number: float = Field()`
	`413`	`+ id: int = Field()`
	`414`	`+ number: int = Field()`
`415`	`415`	`url: str = Field()`
`416`	`416`
`417`	`417`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ class CodeScanningDefaultSetupType(TypedDict):`
`38`	`38`	`]`
`39`	`39`	`]`
`40`	`40`	`]`
	`41`	`+ runner_type: NotRequired[Union[None, Literal["standard", "labeled"]]]`
	`42`	`+ runner_label: NotRequired[Union[str, None]]`
`41`	`43`	`query_suite: NotRequired[Literal["default", "extended"]]`
`42`	`44`	`updated_at: NotRequired[Union[datetime, None]]`
`43`	`45`	`schedule: NotRequired[Union[None, Literal["weekly"]]]`