feat: docs: Deprecate API Shield Schema Validation resources

* docs: Deprecate API Shield Schema Validation resources

This change marks old schema validation resources as deprecated.

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 1924
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-6183ef87f1b8eea6ad4bae542bfde2ec23a5526ae2b7bacdf6c6a4c48d990995.yml
 openapi_spec_hash: 9c8ac3d56571ebf1e170d993b71ccb4d
-config_hash: 56e587ca83a584af152a4bf8a9cfb29e
+config_hash: 451a804e08d2f5fd5d9a8bf33148878c

api.md

@@ -2860,16 +2860,16 @@ Types:
 
 ```python
 from cloudflare.types.api_gateway.operations import (
+    SettingsMultipleRequest,
     SchemaValidationUpdateResponse,
-    SchemaValidationEditResponse,
     SchemaValidationGetResponse,
 )
 ```
 
 Methods:
 
 - <code title="put /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation">client.api_gateway.operations.schema_validation.<a href="./src/cloudflare/resources/api_gateway/operations/schema_validation.py">update</a>(operation_id, \*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/operations/schema_validation_update_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/operations/schema_validation_update_response.py">SchemaValidationUpdateResponse</a></code>
-- <code title="patch /zones/{zone_id}/api_gateway/operations/schema_validation">client.api_gateway.operations.schema_validation.<a href="./src/cloudflare/resources/api_gateway/operations/schema_validation.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/operations/schema_validation_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/operations/schema_validation_edit_response.py">SchemaValidationEditResponse</a></code>
+- <code title="patch /zones/{zone_id}/api_gateway/operations/schema_validation">client.api_gateway.operations.schema_validation.<a href="./src/cloudflare/resources/api_gateway/operations/schema_validation.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/operations/schema_validation_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/operations/settings_multiple_request.py">SettingsMultipleRequest</a></code>
 - <code title="get /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation">client.api_gateway.operations.schema_validation.<a href="./src/cloudflare/resources/api_gateway/operations/schema_validation.py">get</a>(operation_id, \*, zone_id) -> <a href="./src/cloudflare/types/api_gateway/operations/schema_validation_get_response.py">SchemaValidationGetResponse</a></code>
 
 ## Schemas
@@ -2886,23 +2886,19 @@ Methods:
 
 ## Settings
 
-### SchemaValidation
-
 Types:
 
 ```python
-from cloudflare.types.api_gateway.settings import (
-    SchemaValidationUpdateResponse,
-    SchemaValidationEditResponse,
-    SchemaValidationGetResponse,
-)
+from cloudflare.types.api_gateway import Settings
 ```
 
+### SchemaValidation
+
 Methods:
 
-- <code title="put /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/settings/schema_validation_update_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/settings/schema_validation_update_response.py">SchemaValidationUpdateResponse</a></code>
-- <code title="patch /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/settings/schema_validation_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/settings/schema_validation_edit_response.py">SchemaValidationEditResponse</a></code>
-- <code title="get /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/api_gateway/settings/schema_validation_get_response.py">SchemaValidationGetResponse</a></code>
+- <code title="put /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/settings/schema_validation_update_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/settings/settings.py">Settings</a></code>
+- <code title="patch /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/api_gateway/settings/schema_validation_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/api_gateway/settings/settings.py">Settings</a></code>
+- <code title="get /zones/{zone_id}/api_gateway/settings/schema_validation">client.api_gateway.settings.schema_validation.<a href="./src/cloudflare/resources/api_gateway/settings/schema_validation.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/api_gateway/settings/settings.py">Settings</a></code>
 
 ## UserSchemas
 

src/cloudflare/resources/api_gateway/operations/schema_validation.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import typing_extensions
-from typing import Dict, Type, Optional, cast
+from typing import Type, Optional, cast
 from typing_extensions import Literal
 
 import httpx
@@ -20,9 +20,14 @@
 )
 from ...._wrappers import ResultWrapper
 from ...._base_client import make_request_options
-from ....types.api_gateway.operations import schema_validation_edit_params, schema_validation_update_params
+from ....types.api_gateway.operations import (
+    SettingsMultipleRequest,
+    schema_validation_edit_params,
+    schema_validation_update_params,
+)
+from ....types.api_gateway.operations.settings_multiple_request import SettingsMultipleRequest
 from ....types.api_gateway.operations.schema_validation_get_response import SchemaValidationGetResponse
-from ....types.api_gateway.operations.schema_validation_edit_response import SchemaValidationEditResponse
+from ....types.api_gateway.operations.settings_multiple_request_param import SettingsMultipleRequestParam
 from ....types.api_gateway.operations.schema_validation_update_response import SchemaValidationUpdateResponse
 
 __all__ = ["SchemaValidationResource", "AsyncSchemaValidationResource"]
@@ -111,14 +116,14 @@ def edit(
         self,
         *,
         zone_id: str,
-        body: Dict[str, schema_validation_edit_params.Body],
+        settings_multiple_request: SettingsMultipleRequestParam,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationEditResponse:
+    ) -> SettingsMultipleRequest:
         """
         Updates multiple operation-level schema validation settings on the zone
 
@@ -137,15 +142,15 @@ def edit(
             raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
         return self._patch(
             f"/zones/{zone_id}/api_gateway/operations/schema_validation",
-            body=maybe_transform(body, schema_validation_edit_params.SchemaValidationEditParams),
+            body=maybe_transform(settings_multiple_request, schema_validation_edit_params.SchemaValidationEditParams),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[SchemaValidationEditResponse]._unwrapper,
+                post_parser=ResultWrapper[SettingsMultipleRequest]._unwrapper,
             ),
-            cast_to=cast(Type[SchemaValidationEditResponse], ResultWrapper[SchemaValidationEditResponse]),
+            cast_to=cast(Type[SettingsMultipleRequest], ResultWrapper[SettingsMultipleRequest]),
         )
 
     @typing_extensions.deprecated(
@@ -275,14 +280,14 @@ async def edit(
         self,
         *,
         zone_id: str,
-        body: Dict[str, schema_validation_edit_params.Body],
+        settings_multiple_request: SettingsMultipleRequestParam,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationEditResponse:
+    ) -> SettingsMultipleRequest:
         """
         Updates multiple operation-level schema validation settings on the zone
 
@@ -301,15 +306,17 @@ async def edit(
             raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
         return await self._patch(
             f"/zones/{zone_id}/api_gateway/operations/schema_validation",
-            body=await async_maybe_transform(body, schema_validation_edit_params.SchemaValidationEditParams),
+            body=await async_maybe_transform(
+                settings_multiple_request, schema_validation_edit_params.SchemaValidationEditParams
+            ),
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
                 extra_body=extra_body,
                 timeout=timeout,
-                post_parser=ResultWrapper[SchemaValidationEditResponse]._unwrapper,
+                post_parser=ResultWrapper[SettingsMultipleRequest]._unwrapper,
             ),
-            cast_to=cast(Type[SchemaValidationEditResponse], ResultWrapper[SchemaValidationEditResponse]),
+            cast_to=cast(Type[SettingsMultipleRequest], ResultWrapper[SettingsMultipleRequest]),
         )
 
     @typing_extensions.deprecated(

src/cloudflare/resources/api_gateway/settings/schema_validation.py

@@ -20,9 +20,7 @@
 )
 from ...._base_client import make_request_options
 from ....types.api_gateway.settings import schema_validation_edit_params, schema_validation_update_params
-from ....types.api_gateway.settings.schema_validation_get_response import SchemaValidationGetResponse
-from ....types.api_gateway.settings.schema_validation_edit_response import SchemaValidationEditResponse
-from ....types.api_gateway.settings.schema_validation_update_response import SchemaValidationUpdateResponse
+from ....types.api_gateway.settings.settings import Settings
 
 __all__ = ["SchemaValidationResource", "AsyncSchemaValidationResource"]
 
@@ -62,7 +60,7 @@ def update(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationUpdateResponse:
+    ) -> Settings:
         """
         Updates zone level schema validation settings on the zone
 
@@ -109,7 +107,7 @@ def update(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationUpdateResponse,
+            cast_to=Settings,
         )
 
     @typing_extensions.deprecated(
@@ -127,7 +125,7 @@ def edit(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationEditResponse:
+    ) -> Settings:
         """
         Updates zone level schema validation settings on the zone
 
@@ -175,7 +173,7 @@ def edit(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationEditResponse,
+            cast_to=Settings,
         )
 
     @typing_extensions.deprecated(
@@ -191,7 +189,7 @@ def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationGetResponse:
+    ) -> Settings:
         """
         Retrieves zone level schema validation settings currently set on the zone
 
@@ -213,7 +211,7 @@ def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationGetResponse,
+            cast_to=Settings,
         )
 
 
@@ -252,7 +250,7 @@ async def update(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationUpdateResponse:
+    ) -> Settings:
         """
         Updates zone level schema validation settings on the zone
 
@@ -299,7 +297,7 @@ async def update(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationUpdateResponse,
+            cast_to=Settings,
         )
 
     @typing_extensions.deprecated(
@@ -317,7 +315,7 @@ async def edit(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationEditResponse:
+    ) -> Settings:
         """
         Updates zone level schema validation settings on the zone
 
@@ -365,7 +363,7 @@ async def edit(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationEditResponse,
+            cast_to=Settings,
         )
 
     @typing_extensions.deprecated(
@@ -381,7 +379,7 @@ async def get(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SchemaValidationGetResponse:
+    ) -> Settings:
         """
         Retrieves zone level schema validation settings currently set on the zone
 
@@ -403,7 +401,7 @@ async def get(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SchemaValidationGetResponse,
+            cast_to=Settings,
         )
 
 

src/cloudflare/types/api_gateway/__init__.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from .message import Message as Message
+from .settings import Settings as Settings
 from .configuration import Configuration as Configuration
 from .old_public_schema import OldPublicSchema as OldPublicSchema
 from .schema_list_params import SchemaListParams as SchemaListParams

src/cloudflare/types/api_gateway/operations/__init__.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 
+from .settings_multiple_request import SettingsMultipleRequest as SettingsMultipleRequest
 from .schema_validation_edit_params import SchemaValidationEditParams as SchemaValidationEditParams
 from .schema_validation_get_response import SchemaValidationGetResponse as SchemaValidationGetResponse
-from .schema_validation_edit_response import SchemaValidationEditResponse as SchemaValidationEditResponse
 from .schema_validation_update_params import SchemaValidationUpdateParams as SchemaValidationUpdateParams
+from .settings_multiple_request_param import SettingsMultipleRequestParam as SettingsMultipleRequestParam
 from .schema_validation_update_response import SchemaValidationUpdateResponse as SchemaValidationUpdateResponse

src/cloudflare/types/api_gateway/operations/schema_validation_edit_params.py

@@ -2,27 +2,15 @@
 
 from __future__ import annotations
 
-from typing import Dict, Optional
-from typing_extensions import Literal, Required, TypedDict
+from typing_extensions import Required, TypedDict
 
-__all__ = ["SchemaValidationEditParams", "Body"]
+from .settings_multiple_request_param import SettingsMultipleRequestParam
+
+__all__ = ["SchemaValidationEditParams"]
 
 
 class SchemaValidationEditParams(TypedDict, total=False):
     zone_id: Required[str]
     """Identifier."""
 
-    body: Required[Dict[str, Body]]
-
-
-class Body(TypedDict, total=False):
-    mitigation_action: Optional[Literal["log", "block", "none"]]
-    """When set, this applies a mitigation action to this operation
-
-    - `log` log request when request does not conform to schema for this operation
-    - `block` deny access to the site when request does not conform to schema for
-      this operation
-    - `none` will skip mitigation for this operation
-    - `null` indicates that no operation level mitigation is in place, see Zone
-      Level Schema Validation Settings for mitigation action that will be applied
-    """
+    settings_multiple_request: Required[SettingsMultipleRequestParam]

…tions/schema_validation_edit_response.py …/operations/settings_multiple_request.pysrc/cloudflare/types/api_gateway/operations/schema_validation_edit_response.py renamed to src/cloudflare/types/api_gateway/operations/settings_multiple_request.py src/cloudflare/types/api_gateway/operations/schema_validation_edit_response.py renamed to src/cloudflare/types/api_gateway/operations/settings_multiple_request.py

@@ -5,10 +5,10 @@
 
 from ...._models import BaseModel
 
-__all__ = ["SchemaValidationEditResponse", "SchemaValidationEditResponseItem"]
+__all__ = ["SettingsMultipleRequest", "SettingsMultipleRequestItem"]
 
 
-class SchemaValidationEditResponseItem(BaseModel):
+class SettingsMultipleRequestItem(BaseModel):
     mitigation_action: Optional[Literal["log", "block", "none"]] = None
     """When set, this applies a mitigation action to this operation
 
@@ -21,4 +21,4 @@ class SchemaValidationEditResponseItem(BaseModel):
     """
 
 
-SchemaValidationEditResponse: TypeAlias = Dict[str, SchemaValidationEditResponseItem]
+SettingsMultipleRequest: TypeAlias = Dict[str, SettingsMultipleRequestItem]

src/cloudflare/types/api_gateway/operations/settings_multiple_request_param.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import Literal, TypeAlias, TypedDict
+
+__all__ = ["SettingsMultipleRequestParam", "SettingsMultipleRequestParamItem"]
+
+
+class SettingsMultipleRequestParamItem(TypedDict, total=False):
+    mitigation_action: Optional[Literal["log", "block", "none"]]
+    """When set, this applies a mitigation action to this operation
+
+    - `log` log request when request does not conform to schema for this operation
+    - `block` deny access to the site when request does not conform to schema for
+      this operation
+    - `none` will skip mitigation for this operation
+    - `null` indicates that no operation level mitigation is in place, see Zone
+      Level Schema Validation Settings for mitigation action that will be applied
+    """
+
+
+SettingsMultipleRequestParam: TypeAlias = Dict[str, SettingsMultipleRequestParamItem]

src/cloudflare/types/api_gateway/settings/__init__.py

@@ -2,8 +2,6 @@
 
 from __future__ import annotations
 
+from .settings import Settings as Settings
 from .schema_validation_edit_params import SchemaValidationEditParams as SchemaValidationEditParams
-from .schema_validation_get_response import SchemaValidationGetResponse as SchemaValidationGetResponse
-from .schema_validation_edit_response import SchemaValidationEditResponse as SchemaValidationEditResponse
 from .schema_validation_update_params import SchemaValidationUpdateParams as SchemaValidationUpdateParams
-from .schema_validation_update_response import SchemaValidationUpdateResponse as SchemaValidationUpdateResponse