feat(api): OpenAPI spec update via Stainless API (#1190)

cloudflare · Jul 16, 2024 · 8b0313c · 8b0313c
1 parent cc2267d
commit 8b0313c
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 22 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 1256
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-8698fc16cc1cd7549c7f51bf3f3118b80e198b25fee1f20e4aaeb226608dafd1.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-129ae207bac48d5f0a569cefeb5ff52209e7ef746666eb4e8f72aeb08a7748aa.yml
diff --git a/src/cloudflare/resources/dns/firewall/firewall.py b/src/cloudflare/resources/dns/firewall/firewall.py
@@ -89,11 +89,16 @@ def create(
 
           ecs_fallback: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
 
-          maximum_cache_ttl: Maximum DNS Cache TTL.
+          maximum_cache_ttl: Maximum DNS cache TTL. This setting sets an upper bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Higher TTLs will be
+              decreased to the maximum defined here for caching purposes.
 
-          minimum_cache_ttl: Minimum DNS Cache TTL.
+          minimum_cache_ttl: Minimum DNS cache TTL. This setting sets a lower bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Lower TTLs will be
+              increased to the minimum defined here for caching purposes.
 
-          negative_cache_ttl: Negative DNS Cache TTL.
+          negative_cache_ttl: Negative DNS cache TTL. This setting controls how long DNS Firewall should cache
+              negative responses (e.g., NXDOMAIN) from the upstream servers.
 
           ratelimit: Ratelimit in queries per second per datacenter (applies to DNS queries sent to
               the upstream nameservers configured on the cluster).
@@ -272,15 +277,20 @@ def edit(
 
           ecs_fallback: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
 
-          maximum_cache_ttl: Maximum DNS Cache TTL.
+          maximum_cache_ttl: Maximum DNS cache TTL. This setting sets an upper bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Higher TTLs will be
+              decreased to the maximum defined here for caching purposes.
 
-          minimum_cache_ttl: Minimum DNS Cache TTL.
+          minimum_cache_ttl: Minimum DNS cache TTL. This setting sets a lower bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Lower TTLs will be
+              increased to the minimum defined here for caching purposes.
 
           name: DNS Firewall Cluster Name.
 
           attack_mitigation: Attack mitigation settings.
 
-          negative_cache_ttl: Negative DNS Cache TTL.
+          negative_cache_ttl: Negative DNS cache TTL. This setting controls how long DNS Firewall should cache
+              negative responses (e.g., NXDOMAIN) from the upstream servers.
 
           ratelimit: Ratelimit in queries per second per datacenter (applies to DNS queries sent to
               the upstream nameservers configured on the cluster).
@@ -422,11 +432,16 @@ async def create(
 
           ecs_fallback: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
 
-          maximum_cache_ttl: Maximum DNS Cache TTL.
+          maximum_cache_ttl: Maximum DNS cache TTL. This setting sets an upper bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Higher TTLs will be
+              decreased to the maximum defined here for caching purposes.
 
-          minimum_cache_ttl: Minimum DNS Cache TTL.
+          minimum_cache_ttl: Minimum DNS cache TTL. This setting sets a lower bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Lower TTLs will be
+              increased to the minimum defined here for caching purposes.
 
-          negative_cache_ttl: Negative DNS Cache TTL.
+          negative_cache_ttl: Negative DNS cache TTL. This setting controls how long DNS Firewall should cache
+              negative responses (e.g., NXDOMAIN) from the upstream servers.
 
           ratelimit: Ratelimit in queries per second per datacenter (applies to DNS queries sent to
               the upstream nameservers configured on the cluster).
@@ -605,15 +620,20 @@ async def edit(
 
           ecs_fallback: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
 
-          maximum_cache_ttl: Maximum DNS Cache TTL.
+          maximum_cache_ttl: Maximum DNS cache TTL. This setting sets an upper bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Higher TTLs will be
+              decreased to the maximum defined here for caching purposes.
 
-          minimum_cache_ttl: Minimum DNS Cache TTL.
+          minimum_cache_ttl: Minimum DNS cache TTL. This setting sets a lower bound on DNS TTLs for purposes
+              of caching between DNS Firewall and the upstream servers. Lower TTLs will be
+              increased to the minimum defined here for caching purposes.
 
           name: DNS Firewall Cluster Name.
 
           attack_mitigation: Attack mitigation settings.
 
-          negative_cache_ttl: Negative DNS Cache TTL.
+          negative_cache_ttl: Negative DNS cache TTL. This setting controls how long DNS Firewall should cache
+              negative responses (e.g., NXDOMAIN) from the upstream servers.
 
           ratelimit: Ratelimit in queries per second per datacenter (applies to DNS queries sent to
               the upstream nameservers configured on the cluster).

diff --git a/src/cloudflare/types/dns/firewall/firewall.py b/src/cloudflare/types/dns/firewall/firewall.py
@@ -24,10 +24,20 @@ class Firewall(BaseModel):
     """Forward client IP (resolver) subnet if no EDNS Client Subnet is sent."""
 
     maximum_cache_ttl: float
-    """Maximum DNS Cache TTL."""
+    """Maximum DNS cache TTL.
+
+    This setting sets an upper bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Higher TTLs will be decreased to the maximum
+    defined here for caching purposes.
+    """
 
     minimum_cache_ttl: float
-    """Minimum DNS Cache TTL."""
+    """Minimum DNS cache TTL.
+
+    This setting sets a lower bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Lower TTLs will be increased to the minimum
+    defined here for caching purposes.
+    """
 
     modified_on: datetime
     """Last modification of DNS Firewall cluster."""
@@ -41,7 +51,11 @@ class Firewall(BaseModel):
     """Attack mitigation settings."""
 
     negative_cache_ttl: Optional[float] = None
-    """Negative DNS Cache TTL."""
+    """Negative DNS cache TTL.
+
+    This setting controls how long DNS Firewall should cache negative responses
+    (e.g., NXDOMAIN) from the upstream servers.
+    """
 
     ratelimit: Optional[float] = None
     """

diff --git a/src/cloudflare/types/dns/firewall_create_params.py b/src/cloudflare/types/dns/firewall_create_params.py
@@ -30,13 +30,27 @@ class FirewallCreateParams(TypedDict, total=False):
     """Forward client IP (resolver) subnet if no EDNS Client Subnet is sent."""
 
     maximum_cache_ttl: float
-    """Maximum DNS Cache TTL."""
+    """Maximum DNS cache TTL.
+
+    This setting sets an upper bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Higher TTLs will be decreased to the maximum
+    defined here for caching purposes.
+    """
 
     minimum_cache_ttl: float
-    """Minimum DNS Cache TTL."""
+    """Minimum DNS cache TTL.
+
+    This setting sets a lower bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Lower TTLs will be increased to the minimum
+    defined here for caching purposes.
+    """
 
     negative_cache_ttl: Optional[float]
-    """Negative DNS Cache TTL."""
+    """Negative DNS cache TTL.
+
+    This setting controls how long DNS Firewall should cache negative responses
+    (e.g., NXDOMAIN) from the upstream servers.
+    """
 
     ratelimit: Optional[float]
     """

diff --git a/src/cloudflare/types/dns/firewall_edit_params.py b/src/cloudflare/types/dns/firewall_edit_params.py
@@ -28,10 +28,20 @@ class FirewallEditParams(TypedDict, total=False):
     """Forward client IP (resolver) subnet if no EDNS Client Subnet is sent."""
 
     maximum_cache_ttl: Required[float]
-    """Maximum DNS Cache TTL."""
+    """Maximum DNS cache TTL.
+
+    This setting sets an upper bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Higher TTLs will be decreased to the maximum
+    defined here for caching purposes.
+    """
 
     minimum_cache_ttl: Required[float]
-    """Minimum DNS Cache TTL."""
+    """Minimum DNS cache TTL.
+
+    This setting sets a lower bound on DNS TTLs for purposes of caching between DNS
+    Firewall and the upstream servers. Lower TTLs will be increased to the minimum
+    defined here for caching purposes.
+    """
 
     name: Required[str]
     """DNS Firewall Cluster Name."""
@@ -42,7 +52,11 @@ class FirewallEditParams(TypedDict, total=False):
     """Attack mitigation settings."""
 
     negative_cache_ttl: Optional[float]
-    """Negative DNS Cache TTL."""
+    """Negative DNS cache TTL.
+
+    This setting controls how long DNS Firewall should cache negative responses
+    (e.g., NXDOMAIN) from the upstream servers.
+    """
 
     ratelimit: Optional[float]
     """