✨ Feature: add option for disable rest api input body validation (#152)

yanyongyu · Oct 10, 2024 · 8f1ffbb · 8f1ffbb
1 parent e8f0bfb
commit 8f1ffbb
Show file tree

Hide file tree

Showing 60 changed files with 3,647 additions and 2,313 deletions.
diff --git a/codegen/templates/rest/_request.py.jinja b/codegen/templates/rest/_request.py.jinja
@@ -48,7 +48,8 @@ cookies = {
 {{ name }} = data
 {% endif %}
 {% if request_body.type in ["json", "form"] %}
-{{ name }} = type_validate_python({{ request_body.body_schema.get_type_string() }}, {{ name }})
+if self._github.config.rest_api_body_validation:
+    {{ name }} = type_validate_python({{ request_body.body_schema.get_type_string() }}, {{ name }})
 {{ name }} = model_dump({{ name }}) if isinstance({{ name }}, BaseModel) else {{ name }}
 {% endif %}
 {% endmacro %}

diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md
@@ -14,6 +14,7 @@ github = GitHub(
     timeout=None,
     http_cache=True,
     auto_retry=True,
+    rest_api_body_validation=True,
 )
 ```
 
@@ -32,6 +33,7 @@ config = Config(
     timeout=httpx.Timeout(None),
     http_cache=True,
     auto_retry=RETRY_DEFAULT,
+    rest_api_body_validation=True,
 )
 
 github = GitHub(config=config)
@@ -70,3 +72,7 @@ The `http_cache` option enables the http caching feature powered by [Hishel](htt
 ### `auto_retry`
 
 The `auto_retry` option enables request retrying when rate limit exceeded and server error encountered. See [Auto Retry](./auto-retry.md) for more infomation.
+
+### `rest_api_body_validation`
+
+The `rest_api_body_validation` option is used to enable or disable the rest API request body validation. By default, githubkit validates the input data against the GitHub API schema. If you do not want to validate the input data, you can set this option to `False`.
diff --git a/githubkit/config.py b/githubkit/config.py
@@ -17,6 +17,7 @@ class Config:
     timeout: httpx.Timeout
     http_cache: bool
     auto_retry: Optional[RetryDecisionFunc]
+    rest_api_body_validation: bool
 
     def dict(self) -> Dict[str, Any]:
         return asdict(self)
@@ -83,6 +84,7 @@ def get_config(
     timeout: Optional[Union[float, httpx.Timeout]] = None,
     http_cache: bool = True,
     auto_retry: Union[bool, RetryDecisionFunc] = True,
+    rest_api_body_validation: bool = True,
 ) -> Config:
     return Config(
         build_base_url(base_url),
@@ -92,4 +94,5 @@ def get_config(
         build_timeout(timeout),
         http_cache,
         build_auto_retry(auto_retry),
+        rest_api_body_validation,
     )
diff --git a/githubkit/core.py b/githubkit/core.py
@@ -93,6 +93,7 @@ def __init__(
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
         auto_retry: Union[bool, RetryDecisionFunc] = True,
+        rest_api_body_validation: bool = True,
     ): ...
 
     # token auth without config
@@ -109,6 +110,7 @@ def __init__(
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
         auto_retry: Union[bool, RetryDecisionFunc] = True,
+        rest_api_body_validation: bool = True,
     ): ...
 
     # other auth strategies without config
@@ -125,6 +127,7 @@ def __init__(
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
         auto_retry: Union[bool, RetryDecisionFunc] = True,
+        rest_api_body_validation: bool = True,
     ): ...
 
     def __init__(
@@ -140,6 +143,7 @@ def __init__(
         timeout: Optional[Union[float, httpx.Timeout]] = None,
         http_cache: bool = True,
         auto_retry: Union[bool, RetryDecisionFunc] = True,
+        rest_api_body_validation: bool = True,
     ):
         auth = auth or UnauthAuthStrategy()  # type: ignore
         self.auth: A = (  # type: ignore
@@ -155,6 +159,7 @@ def __init__(
             timeout,
             http_cache,
             auto_retry,
+            rest_api_body_validation,
         )
 
         self.__sync_client: ContextVar[Optional[httpx.Client]] = ContextVar(

diff --git a/githubkit/github.py b/githubkit/github.py
@@ -84,6 +84,7 @@ def __init__(
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
             auto_retry: Union[bool, RetryDecisionFunc] = True,
+            rest_api_body_validation: bool = True,
         ): ...
 
         # token auth without config
@@ -100,6 +101,7 @@ def __init__(
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
             auto_retry: Union[bool, RetryDecisionFunc] = True,
+            rest_api_body_validation: bool = True,
         ): ...
 
         # other auth strategies without config
@@ -116,6 +118,7 @@ def __init__(
             timeout: Optional[Union[float, httpx.Timeout]] = None,
             http_cache: bool = True,
             auto_retry: Union[bool, RetryDecisionFunc] = True,
+            rest_api_body_validation: bool = True,
         ): ...
 
         def __init__(self, *args, **kwargs): ...