Skip to content

Commit 3a8a22d

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(api): update composite API spec
1 parent 92a159e commit 3a8a22d

File tree

2 files changed

+158
-50
lines changed

2 files changed

+158
-50
lines changed

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1826
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-436dae5b63cd3641097063829d648648b983691f35bac8d179d970741190e128.yml
3-
openapi_spec_hash: 44627cc45ee6623f37d3b9619b124ea5
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-72ce892ddf4f0cfe8ab511c2f84e4f8612d839ba17e981262ccc0e29c7c4c5df.yml
3+
openapi_spec_hash: e93d4fcda4bcd5ec1a77ddb5782ffd78
44
config_hash: 59212900ef3970ac3c41ca2537fabe7b

‎src/resources/dns-firewall/dns-firewall.ts‎

Lines changed: 156 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -214,16 +214,30 @@ export interface DNSFirewallCreateResponse {
214214
ecs_fallback: boolean;
215215

216216
/**
217-
* Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
218-
* of caching between DNS Firewall and the upstream servers. Higher TTLs will be
219-
* decreased to the maximum defined here for caching purposes.
217+
* By default, Cloudflare attempts to cache responses for as long as indicated by
218+
* the TTL received from upstream nameservers. This setting sets an upper bound on
219+
* this duration. For caching purposes, higher TTLs will be decreased to the
220+
* maximum value defined by this setting.
221+
*
222+
* This setting does not affect the TTL value in the DNS response Cloudflare
223+
* returns to clients. Cloudflare will always forward the TTL value received from
224+
* upstream nameservers.
220225
*/
221226
maximum_cache_ttl: number;
222227

223228
/**
224-
* Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
225-
* of caching between DNS Firewall and the upstream servers. Lower TTLs will be
226-
* increased to the minimum defined here for caching purposes.
229+
* By default, Cloudflare attempts to cache responses for as long as indicated by
230+
* the TTL received from upstream nameservers. This setting sets a lower bound on
231+
* this duration. For caching purposes, lower TTLs will be increased to the minimum
232+
* value defined by this setting.
233+
*
234+
* This setting does not affect the TTL value in the DNS response Cloudflare
235+
* returns to clients. Cloudflare will always forward the TTL value received from
236+
* upstream nameservers.
237+
*
238+
* Note that, even with this setting, there is no guarantee that a response will be
239+
* cached for at least the specified duration. Cached responses may be removed
240+
* earlier for capacity or other operational reasons.
227241
*/
228242
minimum_cache_ttl: number;
229243

@@ -238,8 +252,12 @@ export interface DNSFirewallCreateResponse {
238252
name: string;
239253

240254
/**
241-
* Negative DNS cache TTL This setting controls how long DNS Firewall should cache
242-
* negative responses (e.g., NXDOMAIN) from the upstream servers.
255+
* This setting controls how long DNS Firewall should cache negative responses
256+
* (e.g., NXDOMAIN) from the upstream servers.
257+
*
258+
* This setting does not affect the TTL value in the DNS response Cloudflare
259+
* returns to clients. Cloudflare will always forward the TTL value received from
260+
* upstream nameservers.
243261
*/
244262
negative_cache_ttl: number | null;
245263

@@ -282,16 +300,30 @@ export interface DNSFirewallListResponse {
282300
ecs_fallback: boolean;
283301

284302
/**
285-
* Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
286-
* of caching between DNS Firewall and the upstream servers. Higher TTLs will be
287-
* decreased to the maximum defined here for caching purposes.
303+
* By default, Cloudflare attempts to cache responses for as long as indicated by
304+
* the TTL received from upstream nameservers. This setting sets an upper bound on
305+
* this duration. For caching purposes, higher TTLs will be decreased to the
306+
* maximum value defined by this setting.
307+
*
308+
* This setting does not affect the TTL value in the DNS response Cloudflare
309+
* returns to clients. Cloudflare will always forward the TTL value received from
310+
* upstream nameservers.
288311
*/
289312
maximum_cache_ttl: number;
290313

291314
/**
292-
* Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
293-
* of caching between DNS Firewall and the upstream servers. Lower TTLs will be
294-
* increased to the minimum defined here for caching purposes.
315+
* By default, Cloudflare attempts to cache responses for as long as indicated by
316+
* the TTL received from upstream nameservers. This setting sets a lower bound on
317+
* this duration. For caching purposes, lower TTLs will be increased to the minimum
318+
* value defined by this setting.
319+
*
320+
* This setting does not affect the TTL value in the DNS response Cloudflare
321+
* returns to clients. Cloudflare will always forward the TTL value received from
322+
* upstream nameservers.
323+
*
324+
* Note that, even with this setting, there is no guarantee that a response will be
325+
* cached for at least the specified duration. Cached responses may be removed
326+
* earlier for capacity or other operational reasons.
295327
*/
296328
minimum_cache_ttl: number;
297329

@@ -306,8 +338,12 @@ export interface DNSFirewallListResponse {
306338
name: string;
307339

308340
/**
309-
* Negative DNS cache TTL This setting controls how long DNS Firewall should cache
310-
* negative responses (e.g., NXDOMAIN) from the upstream servers.
341+
* This setting controls how long DNS Firewall should cache negative responses
342+
* (e.g., NXDOMAIN) from the upstream servers.
343+
*
344+
* This setting does not affect the TTL value in the DNS response Cloudflare
345+
* returns to clients. Cloudflare will always forward the TTL value received from
346+
* upstream nameservers.
311347
*/
312348
negative_cache_ttl: number | null;
313349

@@ -357,16 +393,30 @@ export interface DNSFirewallEditResponse {
357393
ecs_fallback: boolean;
358394

359395
/**
360-
* Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
361-
* of caching between DNS Firewall and the upstream servers. Higher TTLs will be
362-
* decreased to the maximum defined here for caching purposes.
396+
* By default, Cloudflare attempts to cache responses for as long as indicated by
397+
* the TTL received from upstream nameservers. This setting sets an upper bound on
398+
* this duration. For caching purposes, higher TTLs will be decreased to the
399+
* maximum value defined by this setting.
400+
*
401+
* This setting does not affect the TTL value in the DNS response Cloudflare
402+
* returns to clients. Cloudflare will always forward the TTL value received from
403+
* upstream nameservers.
363404
*/
364405
maximum_cache_ttl: number;
365406

366407
/**
367-
* Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
368-
* of caching between DNS Firewall and the upstream servers. Lower TTLs will be
369-
* increased to the minimum defined here for caching purposes.
408+
* By default, Cloudflare attempts to cache responses for as long as indicated by
409+
* the TTL received from upstream nameservers. This setting sets a lower bound on
410+
* this duration. For caching purposes, lower TTLs will be increased to the minimum
411+
* value defined by this setting.
412+
*
413+
* This setting does not affect the TTL value in the DNS response Cloudflare
414+
* returns to clients. Cloudflare will always forward the TTL value received from
415+
* upstream nameservers.
416+
*
417+
* Note that, even with this setting, there is no guarantee that a response will be
418+
* cached for at least the specified duration. Cached responses may be removed
419+
* earlier for capacity or other operational reasons.
370420
*/
371421
minimum_cache_ttl: number;
372422

@@ -381,8 +431,12 @@ export interface DNSFirewallEditResponse {
381431
name: string;
382432

383433
/**
384-
* Negative DNS cache TTL This setting controls how long DNS Firewall should cache
385-
* negative responses (e.g., NXDOMAIN) from the upstream servers.
434+
* This setting controls how long DNS Firewall should cache negative responses
435+
* (e.g., NXDOMAIN) from the upstream servers.
436+
*
437+
* This setting does not affect the TTL value in the DNS response Cloudflare
438+
* returns to clients. Cloudflare will always forward the TTL value received from
439+
* upstream nameservers.
386440
*/
387441
negative_cache_ttl: number | null;
388442

@@ -425,16 +479,30 @@ export interface DNSFirewallGetResponse {
425479
ecs_fallback: boolean;
426480

427481
/**
428-
* Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes
429-
* of caching between DNS Firewall and the upstream servers. Higher TTLs will be
430-
* decreased to the maximum defined here for caching purposes.
482+
* By default, Cloudflare attempts to cache responses for as long as indicated by
483+
* the TTL received from upstream nameservers. This setting sets an upper bound on
484+
* this duration. For caching purposes, higher TTLs will be decreased to the
485+
* maximum value defined by this setting.
486+
*
487+
* This setting does not affect the TTL value in the DNS response Cloudflare
488+
* returns to clients. Cloudflare will always forward the TTL value received from
489+
* upstream nameservers.
431490
*/
432491
maximum_cache_ttl: number;
433492

434493
/**
435-
* Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes
436-
* of caching between DNS Firewall and the upstream servers. Lower TTLs will be
437-
* increased to the minimum defined here for caching purposes.
494+
* By default, Cloudflare attempts to cache responses for as long as indicated by
495+
* the TTL received from upstream nameservers. This setting sets a lower bound on
496+
* this duration. For caching purposes, lower TTLs will be increased to the minimum
497+
* value defined by this setting.
498+
*
499+
* This setting does not affect the TTL value in the DNS response Cloudflare
500+
* returns to clients. Cloudflare will always forward the TTL value received from
501+
* upstream nameservers.
502+
*
503+
* Note that, even with this setting, there is no guarantee that a response will be
504+
* cached for at least the specified duration. Cached responses may be removed
505+
* earlier for capacity or other operational reasons.
438506
*/
439507
minimum_cache_ttl: number;
440508

@@ -449,8 +517,12 @@ export interface DNSFirewallGetResponse {
449517
name: string;
450518

451519
/**
452-
* Negative DNS cache TTL This setting controls how long DNS Firewall should cache
453-
* negative responses (e.g., NXDOMAIN) from the upstream servers.
520+
* This setting controls how long DNS Firewall should cache negative responses
521+
* (e.g., NXDOMAIN) from the upstream servers.
522+
*
523+
* This setting does not affect the TTL value in the DNS response Cloudflare
524+
* returns to clients. Cloudflare will always forward the TTL value received from
525+
* upstream nameservers.
454526
*/
455527
negative_cache_ttl: number | null;
456528

@@ -507,22 +579,40 @@ export interface DNSFirewallCreateParams {
507579
ecs_fallback?: boolean;
508580

509581
/**
510-
* Body param: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs
511-
* for purposes of caching between DNS Firewall and the upstream servers. Higher
512-
* TTLs will be decreased to the maximum defined here for caching purposes.
582+
* Body param: By default, Cloudflare attempts to cache responses for as long as
583+
* indicated by the TTL received from upstream nameservers. This setting sets an
584+
* upper bound on this duration. For caching purposes, higher TTLs will be
585+
* decreased to the maximum value defined by this setting.
586+
*
587+
* This setting does not affect the TTL value in the DNS response Cloudflare
588+
* returns to clients. Cloudflare will always forward the TTL value received from
589+
* upstream nameservers.
513590
*/
514591
maximum_cache_ttl?: number;
515592

516593
/**
517-
* Body param: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs
518-
* for purposes of caching between DNS Firewall and the upstream servers. Lower
519-
* TTLs will be increased to the minimum defined here for caching purposes.
594+
* Body param: By default, Cloudflare attempts to cache responses for as long as
595+
* indicated by the TTL received from upstream nameservers. This setting sets a
596+
* lower bound on this duration. For caching purposes, lower TTLs will be increased
597+
* to the minimum value defined by this setting.
598+
*
599+
* This setting does not affect the TTL value in the DNS response Cloudflare
600+
* returns to clients. Cloudflare will always forward the TTL value received from
601+
* upstream nameservers.
602+
*
603+
* Note that, even with this setting, there is no guarantee that a response will be
604+
* cached for at least the specified duration. Cached responses may be removed
605+
* earlier for capacity or other operational reasons.
520606
*/
521607
minimum_cache_ttl?: number;
522608

523609
/**
524-
* Body param: Negative DNS cache TTL This setting controls how long DNS Firewall
525-
* should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
610+
* Body param: This setting controls how long DNS Firewall should cache negative
611+
* responses (e.g., NXDOMAIN) from the upstream servers.
612+
*
613+
* This setting does not affect the TTL value in the DNS response Cloudflare
614+
* returns to clients. Cloudflare will always forward the TTL value received from
615+
* upstream nameservers.
526616
*/
527617
negative_cache_ttl?: number | null;
528618

@@ -576,16 +666,30 @@ export interface DNSFirewallEditParams {
576666
ecs_fallback?: boolean;
577667

578668
/**
579-
* Body param: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs
580-
* for purposes of caching between DNS Firewall and the upstream servers. Higher
581-
* TTLs will be decreased to the maximum defined here for caching purposes.
669+
* Body param: By default, Cloudflare attempts to cache responses for as long as
670+
* indicated by the TTL received from upstream nameservers. This setting sets an
671+
* upper bound on this duration. For caching purposes, higher TTLs will be
672+
* decreased to the maximum value defined by this setting.
673+
*
674+
* This setting does not affect the TTL value in the DNS response Cloudflare
675+
* returns to clients. Cloudflare will always forward the TTL value received from
676+
* upstream nameservers.
582677
*/
583678
maximum_cache_ttl?: number;
584679

585680
/**
586-
* Body param: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs
587-
* for purposes of caching between DNS Firewall and the upstream servers. Lower
588-
* TTLs will be increased to the minimum defined here for caching purposes.
681+
* Body param: By default, Cloudflare attempts to cache responses for as long as
682+
* indicated by the TTL received from upstream nameservers. This setting sets a
683+
* lower bound on this duration. For caching purposes, lower TTLs will be increased
684+
* to the minimum value defined by this setting.
685+
*
686+
* This setting does not affect the TTL value in the DNS response Cloudflare
687+
* returns to clients. Cloudflare will always forward the TTL value received from
688+
* upstream nameservers.
689+
*
690+
* Note that, even with this setting, there is no guarantee that a response will be
691+
* cached for at least the specified duration. Cached responses may be removed
692+
* earlier for capacity or other operational reasons.
589693
*/
590694
minimum_cache_ttl?: number;
591695

@@ -595,8 +699,12 @@ export interface DNSFirewallEditParams {
595699
name?: string;
596700

597701
/**
598-
* Body param: Negative DNS cache TTL This setting controls how long DNS Firewall
599-
* should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
702+
* Body param: This setting controls how long DNS Firewall should cache negative
703+
* responses (e.g., NXDOMAIN) from the upstream servers.
704+
*
705+
* This setting does not affect the TTL value in the DNS response Cloudflare
706+
* returns to clients. Cloudflare will always forward the TTL value received from
707+
* upstream nameservers.
600708
*/
601709
negative_cache_ttl?: number | null;
602710

0 commit comments

Comments
 (0)