feat(api): aggregated API specs update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 524
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gcore%2Fgcore-b473743ee0ba83806f1c8fad37c8dc55062a7d64b726e4ce2ee7e6ed679500a0.yml
-openapi_spec_hash: 990a444fc9f47cee9b92c1fc8915f6ac
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gcore%2Fgcore-b274569f3b7b4720901d8180f3ce6072354a76aebcba71034efacc0d7c2e86af.yml
+openapi_spec_hash: 23852eed0d43bf23e4bdce79570b7742
 config_hash: b2097de8bb0184ce4379a853a61ef740

src/gcore/resources/waap/domains/advanced_rules.py

@@ -53,7 +53,7 @@ def create(
         enabled: bool,
         name: str,
         source: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         phase: Optional[Literal["access", "header_filter", "body_filter"]] | Omit = omit,
         # 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.
@@ -68,7 +68,8 @@ def create(
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           enabled: Whether or not the rule is enabled
 
@@ -141,7 +142,7 @@ def update(
 
           rule_id: The advanced rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           description: The description assigned to the rule
 
@@ -429,7 +430,7 @@ async def create(
         enabled: bool,
         name: str,
         source: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         phase: Optional[Literal["access", "header_filter", "body_filter"]] | Omit = omit,
         # 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.
@@ -444,7 +445,8 @@ async def create(
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           enabled: Whether or not the rule is enabled
 
@@ -517,7 +519,7 @@ async def update(
 
           rule_id: The advanced rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           description: The description assigned to the rule
 

src/gcore/resources/waap/domains/api_paths.py

@@ -75,12 +75,6 @@ def create(
           path: The API path, locations that are saved for resource IDs will be put in curly
               brackets
 
-          api_groups: An array of api groups associated with the API path
-
-          api_version: The API version
-
-          tags: An array of tags associated with the API path
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -132,14 +126,10 @@ def update(
 
           path_id: The path ID
 
-          api_groups: An array of api groups associated with the API path
-
           path: The updated API path. When updating the path, variables can be renamed, path
               parts can be converted to variables and vice versa.
 
-          status: The status of the discovered API path
-
-          tags: An array of tags associated with the API path
+          status: The different statuses an API path can have
 
           extra_headers: Send extra headers
 
@@ -403,12 +393,6 @@ async def create(
           path: The API path, locations that are saved for resource IDs will be put in curly
               brackets
 
-          api_groups: An array of api groups associated with the API path
-
-          api_version: The API version
-
-          tags: An array of tags associated with the API path
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -460,14 +444,10 @@ async def update(
 
           path_id: The path ID
 
-          api_groups: An array of api groups associated with the API path
-
           path: The updated API path. When updating the path, variables can be renamed, path
               parts can be converted to variables and vice versa.
 
-          status: The status of the discovered API path
-
-          tags: An array of tags associated with the API path
+          status: The different statuses an API path can have
 
           extra_headers: Send extra headers
 

src/gcore/resources/waap/domains/custom_rules.py

@@ -58,7 +58,7 @@ def create(
         conditions: Iterable[custom_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         # 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,
@@ -72,7 +72,8 @@ def create(
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -134,7 +135,7 @@ def update(
 
           rule_id: The custom rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -432,7 +433,7 @@ async def create(
         conditions: Iterable[custom_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         # 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,
@@ -446,7 +447,8 @@ async def create(
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -508,7 +510,7 @@ async def update(
 
           rule_id: The custom rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger

src/gcore/resources/waap/domains/domains.py

@@ -172,7 +172,7 @@ def update(
         self,
         domain_id: int,
         *,
-        status: Literal["active", "monitor"] | Omit = omit,
+        status: Literal["active", "monitor"],
         # 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,
@@ -474,7 +474,7 @@ async def update(
         self,
         domain_id: int,
         *,
-        status: Literal["active", "monitor"] | Omit = omit,
+        status: Literal["active", "monitor"],
         # 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,

src/gcore/resources/waap/domains/firewall_rules.py

@@ -58,7 +58,7 @@ def create(
         conditions: Iterable[firewall_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         # 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,
@@ -430,7 +430,7 @@ async def create(
         conditions: Iterable[firewall_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | Omit = omit,
+        description: str | Omit = omit,
         # 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,

src/gcore/resources/waap/insights.py

@@ -76,7 +76,7 @@ def list_types(
 
           ordering: Sort the response by given field.
 
-          slug: Filter by the slug of the insight type
+          slug: The slug of the insight type
 
           extra_headers: Send extra headers
 
@@ -161,7 +161,7 @@ def list_types(
 
           ordering: Sort the response by given field.
 
-          slug: Filter by the slug of the insight type
+          slug: The slug of the insight type
 
           extra_headers: Send extra headers
 

src/gcore/types/waap/domain_update_params.py

@@ -2,11 +2,11 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, TypedDict
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["DomainUpdateParams"]
 
 
 class DomainUpdateParams(TypedDict, total=False):
-    status: Literal["active", "monitor"]
+    status: Required[Literal["active", "monitor"]]
     """The current status of the domain"""

src/gcore/types/waap/domains/advanced_rule_create_params.py

@@ -12,7 +12,10 @@
 
 class AdvancedRuleCreateParams(TypedDict, total=False):
     action: Required[Action]
-    """The action that the rule takes when triggered"""
+    """The action that the rule takes when triggered.
+
+    Only one action can be set per rule.
+    """
 
     enabled: Required[bool]
     """Whether or not the rule is enabled"""
@@ -28,7 +31,7 @@ class AdvancedRuleCreateParams(TypedDict, total=False):
     https://gcore.com/docs/waap/waap-rules/advanced-rules
     """
 
-    description: Optional[str]
+    description: str
     """The description assigned to the rule"""
 
     phase: Optional[Literal["access", "header_filter", "body_filter"]]
@@ -43,16 +46,16 @@ class AdvancedRuleCreateParams(TypedDict, total=False):
 
 
 class ActionBlock(TypedDict, total=False):
-    action_duration: Optional[str]
+    action_duration: str
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
     'd' to represent time format (seconds, minutes, hours, or days). Empty time
     intervals are not allowed.
     """
 
-    status_code: Optional[Literal[403, 405, 418, 429]]
-    """Designates the HTTP status code to deliver when a request is blocked."""
+    status_code: Literal[403, 405, 418, 429]
+    """A custom HTTP status code that the WAAP returns if a rule blocks a request"""
 
 
 class ActionTag(TypedDict, total=False):
@@ -61,23 +64,23 @@ class ActionTag(TypedDict, total=False):
 
 
 class Action(TypedDict, total=False):
-    allow: Optional[object]
+    allow: object
     """The WAAP allowed the request"""
 
-    block: Optional[ActionBlock]
+    block: ActionBlock
     """
     WAAP block action behavior could be configured with response status code and
     action duration.
     """
 
-    captcha: Optional[object]
+    captcha: object
     """The WAAP presented the user with a captcha"""
 
-    handshake: Optional[object]
+    handshake: object
     """The WAAP performed automatic browser validation"""
 
-    monitor: Optional[object]
+    monitor: object
     """The WAAP monitored the request but took no action"""
 
-    tag: Optional[ActionTag]
+    tag: ActionTag
     """WAAP tag action gets a list of tags to tag the request scope with"""

src/gcore/types/waap/domains/advanced_rule_update_params.py

@@ -15,7 +15,7 @@ class AdvancedRuleUpdateParams(TypedDict, total=False):
     """The domain ID"""
 
     action: Optional[Action]
-    """The action that a WAAP rule takes when triggered"""
+    """The action that a WAAP rule takes when triggered."""
 
     description: Optional[str]
     """The description assigned to the rule"""
@@ -46,16 +46,16 @@ class AdvancedRuleUpdateParams(TypedDict, total=False):
 
 
 class ActionBlock(TypedDict, total=False):
-    action_duration: Optional[str]
+    action_duration: str
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
     'd' to represent time format (seconds, minutes, hours, or days). Empty time
     intervals are not allowed.
     """
 
-    status_code: Optional[Literal[403, 405, 418, 429]]
-    """Designates the HTTP status code to deliver when a request is blocked."""
+    status_code: Literal[403, 405, 418, 429]
+    """A custom HTTP status code that the WAAP returns if a rule blocks a request"""
 
 
 class ActionTag(TypedDict, total=False):
@@ -64,23 +64,23 @@ class ActionTag(TypedDict, total=False):
 
 
 class Action(TypedDict, total=False):
-    allow: Optional[object]
+    allow: object
     """The WAAP allowed the request"""
 
-    block: Optional[ActionBlock]
+    block: ActionBlock
     """
     WAAP block action behavior could be configured with response status code and
     action duration.
     """
 
-    captcha: Optional[object]
+    captcha: object
     """The WAAP presented the user with a captcha"""
 
-    handshake: Optional[object]
+    handshake: object
     """The WAAP performed automatic browser validation"""
 
-    monitor: Optional[object]
+    monitor: object
     """The WAAP monitored the request but took no action"""
 
-    tag: Optional[ActionTag]
+    tag: ActionTag
     """WAAP tag action gets a list of tags to tag the request scope with"""