🐛 Fix: classroom assignment schema fields (#146)

codegen/parser/__init__.py

@@ -31,8 +31,8 @@ def add_schema(ref: httpx.URL, schema: "SchemaData"):
     _schemas.get()[ref] = schema
 
 
-from .utils import merge_dict
 from .models import parse_models
+from .utils import merge_inplace
 from .webhooks import parse_webhook
 from .endpoints import parse_endpoint
 from .utils import sanitize as sanitize
@@ -53,7 +53,7 @@ def parse_openapi_spec(source: "Source", override: "Override") -> OpenAPIData:
     # apply schema overrides first to make sure json pointer is correct
     for path, new_schema in override.schema_overrides.items():
         ref = str(httpx.URL(fragment=path))
-        merge_dict(source.resolve_ref(ref).data, new_schema)
+        merge_inplace(source.resolve_ref(ref).data, new_schema)
 
     _ot = _override_config.set(override)
     _st = _schemas.set({})

codegen/parser/utils.py

@@ -1,7 +1,7 @@
 import re
 import builtins
 from keyword import iskeyword
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar
 
 import openapi_pydantic as oas
 from pydantic import TypeAdapter
@@ -24,6 +24,8 @@
 }
 
 UNSET_KEY = "<unset>"
+ADD_KEY = "<add>"
+REMOVE_KEY = "<remove>"
 
 
 def sanitize(value: str) -> str:
@@ -103,16 +105,40 @@ def build_prop_name(name: str) -> str:
 def merge_dict(old: dict, new: dict):
     # make change inplace to make json point correct
     for key, value in new.items():
+        # remove a field
         if value == UNSET_KEY:
             if key not in old:
                 raise ValueError(f"Key {key} not found in {old}")
             del old[key]
         else:
-            old[key] = (
-                merge_dict(old[key], value)
-                if isinstance(value, dict) and isinstance(old[key], dict)
-                else value
-            )
+            if key not in old:
+                old[key] = value
+            else:
+                try:
+                    merge_inplace(old[key], value)
+                except TypeError:
+                    old[key] = value
+
+
+def merge_list(old: list, new: list | dict):
+    if isinstance(new, list):
+        old.clear()
+        old.extend(new)
+    else:
+        if REMOVE_KEY in new:
+            for item in new[REMOVE_KEY]:
+                old.remove(item)
+        if ADD_KEY in new:
+            old.extend(new[ADD_KEY])
+
+
+def merge_inplace(old: Any, new: Any):
+    if isinstance(old, dict) and isinstance(new, dict):
+        merge_dict(old, new)
+    elif isinstance(old, list) and isinstance(new, list | dict):
+        merge_list(old, new)
+    else:
+        raise TypeError(f"Cannot merge type {type(old)} with {type(new)}")
 
 
 def schema_from_source(source: "Source") -> oas.Schema:

docs/contributing.md

@@ -45,7 +45,9 @@ Please make sure you have activated the virtual environment.
 
 If you encounter an schema error, you can patch the schema by modifying the `pyproject.toml` file.
 
-In the `[tool.codegen.overrides.schema_overrides]` section, you can modify the schema using json pointer. The value will override the original schema. Specially, if the value is `<unset>`, the original one will be removed.
+In the `[tool.codegen.overrides.schema_overrides]` section, you can modify the schema using json pointer. The value will override the original schema.
+
+Specially, if the json pointer points to a dictionary, you can use special value `<unset>` to remove the key from the dictionary. If the json pointer points to a array, you can use a list value to replace the original array. Or you can use a dict with key `<add>` and `<remove>` to add or remove items from the array.
 
 Please add a comment to explain the reason for the patch if you want to submit a PR.
 

githubkit/versions/ghec_v2022_11_28/models/group_0025.py

@@ -89,17 +89,20 @@ class SimpleClassroomAssignment(GitHubModel):
     max_members: Missing[Union[int, None]] = Field(
         default=UNSET, description="The maximum allowable members per team."
     )
-    editor: str = Field(description="The selected editor for the assignment.")
+    editor: Union[str, None] = Field(
+        description="The selected editor for the assignment."
+    )
     accepted: int = Field(
         description="The number of students that have accepted the assignment."
     )
-    submitted: int = Field(
-        description="The number of students that have submitted the assignment."
+    submitted: Missing[int] = Field(
+        default=UNSET,
+        description="The number of students that have submitted the assignment.",
     )
     passing: int = Field(
         description="The number of students that have passed the assignment."
     )
-    language: str = Field(
+    language: Union[str, None] = Field(
         description="The programming language used in the assignment."
     )
     deadline: Union[datetime, None] = Field(

githubkit/versions/ghec_v2022_11_28/types/group_0025.py

@@ -61,11 +61,11 @@ class SimpleClassroomAssignmentType(TypedDict):
     feedback_pull_requests_enabled: bool
     max_teams: NotRequired[Union[int, None]]
     max_members: NotRequired[Union[int, None]]
-    editor: str
+    editor: Union[str, None]
     accepted: int
-    submitted: int
+    submitted: NotRequired[int]
     passing: int
-    language: str
+    language: Union[str, None]
     deadline: Union[datetime, None]
     classroom: SimpleClassroomType
 

githubkit/versions/v2022_11_28/models/group_0025.py

@@ -89,17 +89,20 @@ class SimpleClassroomAssignment(GitHubModel):
     max_members: Missing[Union[int, None]] = Field(
         default=UNSET, description="The maximum allowable members per team."
     )
-    editor: str = Field(description="The selected editor for the assignment.")
+    editor: Union[str, None] = Field(
+        description="The selected editor for the assignment."
+    )
     accepted: int = Field(
         description="The number of students that have accepted the assignment."
     )
-    submitted: int = Field(
-        description="The number of students that have submitted the assignment."
+    submitted: Missing[int] = Field(
+        default=UNSET,
+        description="The number of students that have submitted the assignment.",
     )
     passing: int = Field(
         description="The number of students that have passed the assignment."
     )
-    language: str = Field(
+    language: Union[str, None] = Field(
         description="The programming language used in the assignment."
     )
     deadline: Union[datetime, None] = Field(

githubkit/versions/v2022_11_28/types/group_0025.py

@@ -61,11 +61,11 @@ class SimpleClassroomAssignmentType(TypedDict):
     feedback_pull_requests_enabled: bool
     max_teams: NotRequired[Union[int, None]]
     max_members: NotRequired[Union[int, None]]
-    editor: str
+    editor: Union[str, None]
     accepted: int
-    submitted: int
+    submitted: NotRequired[int]
     passing: int
-    language: str
+    language: Union[str, None]
     deadline: Union[datetime, None]
     classroom: SimpleClassroomType
 

pyproject.toml

@@ -361,25 +361,29 @@ source = "https://raw.githubusercontent.com/github/rest-api-description/main/des
 # https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates
 "/components/parameters/created/schema" = { format = "<unset>" }
 
+# https://github.com/yanyongyu/githubkit/issues/144
+"/components/schemas/simple-classroom-assignment/properties/editor" = { type = [
+  "string",
+  "null",
+] }
+"/components/schemas/simple-classroom-assignment/properties/language" = { type = [
+  "string",
+  "null",
+] }
+"/components/schemas/simple-classroom-assignment/required" = { "<remove>" = [
+  "submitted",
+] }
+
 # Webhook schema overrides
 # webhook check run action is required
-"/components/schemas/webhook-check-run-completed" = { required = [
+"/components/schemas/webhook-check-run-completed/required" = { "<add>" = [
   "action",
-  "check_run",
-  "repository",
-  "sender",
 ] }
-"/components/schemas/webhook-check-run-created" = { required = [
+"/components/schemas/webhook-check-run-created/required" = { "<add>" = [
   "action",
-  "check_run",
-  "repository",
-  "sender",
 ] }
-"/components/schemas/webhook-check-run-rerequested" = { required = [
+"/components/schemas/webhook-check-run-rerequested/required" = { "<add>" = [
   "action",
-  "check_run",
-  "repository",
-  "sender",
 ] }
 
 # webhook github app events enum schema is not always up to date
@@ -414,12 +418,8 @@ source = "https://raw.githubusercontent.com/github/rest-api-description/main/des
   "action",
 ] }
 # webhook secret scanning alert location action is required
-"/components/schemas/webhook-secret-scanning-alert-location-created" = { required = [
+"/components/schemas/webhook-secret-scanning-alert-location-created/required" = { "<add>" = [
   "action",
-  "location",
-  "alert",
-  "repository",
-  "sender",
 ] }
 
 # webhook fork topics can be null