🐛 Fix: deployment payload object allow additional property (#181)

Author: yanyongyu

githubkit/rest/__init__.py

@@ -3750,7 +3750,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreator as WebhookDeploymentCreatedPropDeploymentPropCreator,
     )
     from githubkit.versions.v2022_11_28.models import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1,
     )
     from githubkit.versions.v2022_11_28.models import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp,
@@ -10673,7 +10673,7 @@
             "WebhookDeploymentCreated",
             "WebhookDeploymentCreatedPropDeployment",
             "WebhookDeploymentCreatedPropDeploymentPropCreator",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/ghec_v2022_11_28/models/__init__.py

@@ -2321,7 +2321,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreator as WebhookDeploymentCreatedPropDeploymentPropCreator,
     )
     from .group_0540 import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1,
     )
     from .group_0540 import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp,
@@ -10479,7 +10479,7 @@
             "WebhookDeploymentCreated",
             "WebhookDeploymentCreatedPropDeployment",
             "WebhookDeploymentCreatedPropDeploymentPropCreator",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/ghec_v2022_11_28/models/group_0540.py

@@ -14,7 +14,7 @@
 
 from pydantic import Field
 
-from githubkit.compat import GitHubModel, model_rebuild
+from githubkit.compat import ExtraGitHubModel, GitHubModel, model_rebuild
 from githubkit.typing import Missing
 from githubkit.utils import UNSET
 
@@ -76,7 +76,7 @@ class WebhookDeploymentCreatedPropDeployment(GitHubModel):
     id: int = Field()
     node_id: str = Field()
     original_environment: str = Field()
-    payload: Union[WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0, str] = (
+    payload: Union[str, WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1] = (
         Field()
     )
     performed_via_github_app: Missing[
@@ -124,8 +124,8 @@ class WebhookDeploymentCreatedPropDeploymentPropCreator(GitHubModel):
     user_view_type: Missing[str] = Field(default=UNSET)
 
 
-class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0(GitHubModel):
-    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0"""
+class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1(ExtraGitHubModel):
+    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1"""
 
 
 class WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp(GitHubModel):
@@ -572,7 +572,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
 model_rebuild(WebhookDeploymentCreated)
 model_rebuild(WebhookDeploymentCreatedPropDeployment)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropCreator)
-model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0)
+model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner)
 model_rebuild(
@@ -600,7 +600,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
     "WebhookDeploymentCreated",
     "WebhookDeploymentCreatedPropDeployment",
     "WebhookDeploymentCreatedPropDeploymentPropCreator",
-    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/ghec_v2022_11_28/models/group_0545.py

@@ -14,7 +14,7 @@
 
 from pydantic import Field
 
-from githubkit.compat import GitHubModel, model_rebuild
+from githubkit.compat import ExtraGitHubModel, GitHubModel, model_rebuild
 from githubkit.typing import Missing
 from githubkit.utils import UNSET
 
@@ -167,7 +167,7 @@ class WebhookDeploymentStatusCreatedPropDeploymentPropCreator(GitHubModel):
     user_view_type: Missing[str] = Field(default=UNSET)
 
 
-class WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1(GitHubModel):
+class WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1(ExtraGitHubModel):
     """WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1"""
 
 

githubkit/versions/ghec_v2022_11_28/types/__init__.py

@@ -2605,7 +2605,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreatorType as WebhookDeploymentCreatedPropDeploymentPropCreatorType,
     )
     from .group_0540 import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type,
     )
     from .group_0540 import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType,
@@ -10963,7 +10963,7 @@
             "WebhookDeploymentCreatedType",
             "WebhookDeploymentCreatedPropDeploymentType",
             "WebhookDeploymentCreatedPropDeploymentPropCreatorType",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissionsType",

githubkit/versions/ghec_v2022_11_28/types/group_0540.py

@@ -49,7 +49,7 @@ class WebhookDeploymentCreatedPropDeploymentType(TypedDict):
     id: int
     node_id: str
     original_environment: str
-    payload: Union[WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type, str]
+    payload: Union[str, WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type]
     performed_via_github_app: NotRequired[
         Union[WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType, None]
     ]
@@ -91,8 +91,8 @@ class WebhookDeploymentCreatedPropDeploymentPropCreatorType(TypedDict):
     user_view_type: NotRequired[str]
 
 
-class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type(TypedDict):
-    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0"""
+class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type(TypedDict):
+    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1"""
 
 
 class WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType(TypedDict):
@@ -535,7 +535,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
 
 __all__ = (
     "WebhookDeploymentCreatedPropDeploymentPropCreatorType",
-    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type",
+    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissionsType",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType",

githubkit/versions/latest/models.py

@@ -3750,7 +3750,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreator as WebhookDeploymentCreatedPropDeploymentPropCreator,
     )
     from githubkit.versions.v2022_11_28.models import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1,
     )
     from githubkit.versions.v2022_11_28.models import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp,
@@ -10673,7 +10673,7 @@
             "WebhookDeploymentCreated",
             "WebhookDeploymentCreatedPropDeployment",
             "WebhookDeploymentCreatedPropDeploymentPropCreator",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/latest/types.py

@@ -3880,7 +3880,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreatorType as WebhookDeploymentCreatedPropDeploymentPropCreatorType,
     )
     from githubkit.versions.v2022_11_28.types import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type,
     )
     from githubkit.versions.v2022_11_28.types import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType,
@@ -10847,7 +10847,7 @@
             "WebhookDeploymentCreatedType",
             "WebhookDeploymentCreatedPropDeploymentType",
             "WebhookDeploymentCreatedPropDeploymentPropCreatorType",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissionsType",

githubkit/versions/v2022_11_28/models/__init__.py

@@ -2060,7 +2060,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreator as WebhookDeploymentCreatedPropDeploymentPropCreator,
     )
     from .group_0482 import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1 as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1,
     )
     from .group_0482 import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp,
@@ -9909,7 +9909,7 @@
             "WebhookDeploymentCreated",
             "WebhookDeploymentCreatedPropDeployment",
             "WebhookDeploymentCreatedPropDeploymentPropCreator",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/v2022_11_28/models/group_0482.py

@@ -14,7 +14,7 @@
 
 from pydantic import Field
 
-from githubkit.compat import GitHubModel, model_rebuild
+from githubkit.compat import ExtraGitHubModel, GitHubModel, model_rebuild
 from githubkit.typing import Missing
 from githubkit.utils import UNSET
 
@@ -76,7 +76,7 @@ class WebhookDeploymentCreatedPropDeployment(GitHubModel):
     id: int = Field()
     node_id: str = Field()
     original_environment: str = Field()
-    payload: Union[WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0, str] = (
+    payload: Union[str, WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1] = (
         Field()
     )
     performed_via_github_app: Missing[
@@ -124,8 +124,8 @@ class WebhookDeploymentCreatedPropDeploymentPropCreator(GitHubModel):
     user_view_type: Missing[str] = Field(default=UNSET)
 
 
-class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0(GitHubModel):
-    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0"""
+class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1(ExtraGitHubModel):
+    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1"""
 
 
 class WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp(GitHubModel):
@@ -572,7 +572,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
 model_rebuild(WebhookDeploymentCreated)
 model_rebuild(WebhookDeploymentCreatedPropDeployment)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropCreator)
-model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0)
+model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp)
 model_rebuild(WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner)
 model_rebuild(
@@ -600,7 +600,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
     "WebhookDeploymentCreated",
     "WebhookDeploymentCreatedPropDeployment",
     "WebhookDeploymentCreatedPropDeploymentPropCreator",
-    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0",
+    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubApp",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwner",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissions",

githubkit/versions/v2022_11_28/models/group_0487.py

@@ -14,7 +14,7 @@
 
 from pydantic import Field
 
-from githubkit.compat import GitHubModel, model_rebuild
+from githubkit.compat import ExtraGitHubModel, GitHubModel, model_rebuild
 from githubkit.typing import Missing
 from githubkit.utils import UNSET
 
@@ -167,7 +167,7 @@ class WebhookDeploymentStatusCreatedPropDeploymentPropCreator(GitHubModel):
     user_view_type: Missing[str] = Field(default=UNSET)
 
 
-class WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1(GitHubModel):
+class WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1(ExtraGitHubModel):
     """WebhookDeploymentStatusCreatedPropDeploymentPropPayloadOneof1"""
 
 

githubkit/versions/v2022_11_28/types/__init__.py

@@ -2326,7 +2326,7 @@
         WebhookDeploymentCreatedPropDeploymentPropCreatorType as WebhookDeploymentCreatedPropDeploymentPropCreatorType,
     )
     from .group_0482 import (
-        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type,
+        WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type as WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type,
     )
     from .group_0482 import (
         WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType as WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType,
@@ -10375,7 +10375,7 @@
             "WebhookDeploymentCreatedType",
             "WebhookDeploymentCreatedPropDeploymentType",
             "WebhookDeploymentCreatedPropDeploymentPropCreatorType",
-            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type",
+            "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType",
             "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissionsType",

githubkit/versions/v2022_11_28/types/group_0482.py

@@ -49,7 +49,7 @@ class WebhookDeploymentCreatedPropDeploymentType(TypedDict):
     id: int
     node_id: str
     original_environment: str
-    payload: Union[WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type, str]
+    payload: Union[str, WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type]
     performed_via_github_app: NotRequired[
         Union[WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType, None]
     ]
@@ -91,8 +91,8 @@ class WebhookDeploymentCreatedPropDeploymentPropCreatorType(TypedDict):
     user_view_type: NotRequired[str]
 
 
-class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type(TypedDict):
-    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0"""
+class WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type(TypedDict):
+    """WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1"""
 
 
 class WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType(TypedDict):
@@ -535,7 +535,7 @@ class WebhookDeploymentCreatedPropWorkflowRunPropPullRequestsItemsPropHeadPropRe
 
 __all__ = (
     "WebhookDeploymentCreatedPropDeploymentPropCreatorType",
-    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof0Type",
+    "WebhookDeploymentCreatedPropDeploymentPropPayloadOneof1Type",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropOwnerType",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppPropPermissionsType",
     "WebhookDeploymentCreatedPropDeploymentPropPerformedViaGithubAppType",

pyproject.toml

@@ -429,6 +429,16 @@ source = "https://raw.githubusercontent.com/github/rest-api-description/main/des
 "/components/schemas/webhook-issues-unlocked/properties/issue/properties/performed_via_github_app/properties/events/items" = { enum = "<unset>" }
 "/components/schemas/webhook-meta-deleted/properties/hook/properties/events/items" = { enum = "<unset>" }
 
+# webhook deployment payload object can contain additional properties
+"/components/schemas/webhook-deployment-status-created/properties/deployment/properties/payload" = { oneOf = [
+  { type = "string" },
+  { type = "object", additionalProperties = true },
+] }
+"/components/schemas/webhook-deployment-created/properties/deployment/properties/payload" = { oneOf = [
+  { type = "string" },
+  { type = "object", additionalProperties = true },
+] }
+
 # webhook deployment protection rule action is required
 "/components/schemas/webhook-deployment-protection-rule-requested" = { required = [
   "action",