Skip to content

Commit

Permalink
make docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz committed Sep 18, 2024
1 parent ac555df commit e1d4166
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 21 deletions.
17 changes: 9 additions & 8 deletions docs/data-sources/rulesets.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,14 +164,6 @@ Read-Only:
- `custom_key` (List of Object) (see [below for nested schema](#nestedobjatt--rulesets--rules--action_parameters--version--custom_key))
- `ignore_query_strings_order` (Boolean)

<a id="nestedobjatt--rulesets--rules--action_parameters--cache_reserve"></a>
### Nested Schema for `rulesets.rules.action_parameters.version`

Read-Only:

- `eligible` (Boolean)
- `minimum_file_size` (Number)

<a id="nestedobjatt--rulesets--rules--action_parameters--version--custom_key"></a>
### Nested Schema for `rulesets.rules.action_parameters.version.custom_key`

Expand Down Expand Up @@ -232,6 +224,15 @@ Read-Only:



<a id="nestedobjatt--rulesets--rules--action_parameters--cache_reserve"></a>
### Nested Schema for `rulesets.rules.action_parameters.version`

Read-Only:

- `eligible` (Boolean)
- `minimum_file_size` (Number)


<a id="nestedobjatt--rulesets--rules--action_parameters--edge_ttl"></a>
### Nested Schema for `rulesets.rules.action_parameters.version`

Expand Down
30 changes: 17 additions & 13 deletions docs/resources/ruleset.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,10 @@ resource "cloudflare_ruleset" "cache_settings_example" {
}
}
}
cache_reserve = {
eligible = true
minimum_file_size = 100000
}
origin_error_page_passthru = false
}
expression = "(http.host eq \"example.host.com\")"
Expand Down Expand Up @@ -495,7 +499,7 @@ Optional:
- `browser_ttl` (Block List) List of browser TTL parameters to apply to the request. (see [below for nested schema](#nestedblock--rules--action_parameters--browser_ttl))
- `cache` (Boolean) Whether to cache if expression matches.
- `cache_key` (Block List) List of cache key parameters to apply to the request. (see [below for nested schema](#nestedblock--rules--action_parameters--cache_key))
- `cache_reserve` (Block List) List of cache reserve parameters to apply to the request (see [below for nested schema](#nestedblock--rules--action_parameters--cache_reserve))
- `cache_reserve` (Block List) List of cache reserve parameters to apply to the request. (see [below for nested schema](#nestedblock--rules--action_parameters--cache_reserve))
- `content` (String) Content of the custom error response.
- `content_type` (String) Content-Type of the custom error response.
- `cookie_fields` (Set of String) List of cookie values to include as part of custom fields logging.
Expand Down Expand Up @@ -582,18 +586,6 @@ Optional:
- `custom_key` (Block List) Custom key parameters for the request. (see [below for nested schema](#nestedblock--rules--action_parameters--cache_key--custom_key))
- `ignore_query_strings_order` (Boolean) Ignore query strings order.

<a id="nestedblock--rules--action_parameters--cache_reserve"></a>
### Nested Schema for `rules.action_parameters.cache_reserve`

Required:

- `eligible` (Boolean) Determines whether Cloudflare will write the eligible resource to cache reserve.

Optional:

- `minimum_file_size` (Number) The minimum file size, in bytes, eligible for storage in cache reserve. If omitted and "eligible" is true, Cloudflare will use 0 bytes by default.


<a id="nestedblock--rules--action_parameters--cache_key--custom_key"></a>
### Nested Schema for `rules.action_parameters.cache_key.custom_key`

Expand Down Expand Up @@ -654,6 +646,18 @@ Optional:



<a id="nestedblock--rules--action_parameters--cache_reserve"></a>
### Nested Schema for `rules.action_parameters.cache_reserve`

Required:

- `eligible` (Boolean) Determines whether Cloudflare will write the eligible resource to cache reserve.

Optional:

- `minimum_file_size` (Number) The minimum file size, in bytes, eligible for storage in cache reserve. If omitted and "eligible" is true, Cloudflare will use 0 bytes by default.


<a id="nestedblock--rules--action_parameters--edge_ttl"></a>
### Nested Schema for `rules.action_parameters.edge_ttl`

Expand Down
10 changes: 10 additions & 0 deletions docs/resources/worker_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ resource "cloudflare_worker_script" "my_script" {
- `compatibility_flags` (Set of String) Compatibility flags used for Worker Scripts.
- `d1_database_binding` (Block Set) (see [below for nested schema](#nestedblock--d1_database_binding))
- `dispatch_namespace` (String) Name of the Workers for Platforms dispatch namespace.
- `hyperdrive_config_binding` (Block Set) (see [below for nested schema](#nestedblock--hyperdrive_config_binding))
- `kv_namespace_binding` (Block Set) (see [below for nested schema](#nestedblock--kv_namespace_binding))
- `logpush` (Boolean) Enabling allows Worker events to be sent to a defined Logpush destination.
- `module` (Boolean) Whether to upload Worker as a module.
Expand Down Expand Up @@ -110,6 +111,15 @@ Required:
- `name` (String) The global variable for the binding in your Worker code.


<a id="nestedblock--hyperdrive_config_binding"></a>
### Nested Schema for `hyperdrive_config_binding`

Required:

- `binding` (String) The global variable for the binding in your Worker code.
- `id` (String) The ID of the Hyperdrive config to use.


<a id="nestedblock--kv_namespace_binding"></a>
### Nested Schema for `kv_namespace_binding`

Expand Down
10 changes: 10 additions & 0 deletions docs/resources/workers_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ resource "cloudflare_workers_script" "my_script" {
- `compatibility_flags` (Set of String) Compatibility flags used for Worker Scripts.
- `d1_database_binding` (Block Set) (see [below for nested schema](#nestedblock--d1_database_binding))
- `dispatch_namespace` (String) Name of the Workers for Platforms dispatch namespace.
- `hyperdrive_config_binding` (Block Set) (see [below for nested schema](#nestedblock--hyperdrive_config_binding))
- `kv_namespace_binding` (Block Set) (see [below for nested schema](#nestedblock--kv_namespace_binding))
- `logpush` (Boolean) Enabling allows Worker events to be sent to a defined Logpush destination.
- `module` (Boolean) Whether to upload Worker as a module.
Expand Down Expand Up @@ -110,6 +111,15 @@ Required:
- `name` (String) The global variable for the binding in your Worker code.


<a id="nestedblock--hyperdrive_config_binding"></a>
### Nested Schema for `hyperdrive_config_binding`

Required:

- `binding` (String) The global variable for the binding in your Worker code.
- `id` (String) The ID of the Hyperdrive config to use.


<a id="nestedblock--kv_namespace_binding"></a>
### Nested Schema for `kv_namespace_binding`

Expand Down

0 comments on commit e1d4166

Please sign in to comment.