Skip to content

Commit 21a9cd4

Browse files
committed
chore(docs): generate provider documentation
1 parent 250737b commit 21a9cd4

File tree

74 files changed

+597
-281
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+597
-281
lines changed

docs/data-sources/argo_smart_routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ data "cloudflare_argo_smart_routing" "example_argo_smart_routing" {
2222

2323
### Required
2424

25-
- `zone_id` (String) Identifier
25+
- `zone_id` (String) Specifies the zone associated with the API call.
2626

2727

docs/data-sources/custom_pages.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: |-
1313

1414
```terraform
1515
data "cloudflare_custom_pages" "example_custom_pages" {
16-
identifier = "023e105f4ecef8ad9ca31a8372d0c353"
16+
identifier = "ratelimit_block"
1717
account_id = "account_id"
1818
zone_id = "zone_id"
1919
}
@@ -24,11 +24,24 @@ data "cloudflare_custom_pages" "example_custom_pages" {
2424

2525
### Required
2626

27-
- `identifier` (String) Identifier
27+
- `identifier` (String) Error Page Types
28+
Available values: "waf_block", "ip_block", "country_challenge", "500_errors", "1000_errors", "managed_challenge", "ratelimit_block".
2829

2930
### Optional
3031

3132
- `account_id` (String) The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
3233
- `zone_id` (String) The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
3334

35+
### Read-Only
36+
37+
- `created_on` (String)
38+
- `description` (String)
39+
- `id` (String) The ID of this resource.
40+
- `modified_on` (String)
41+
- `preview_target` (String)
42+
- `required_tokens` (List of String)
43+
- `state` (String) The custom page state.
44+
Available values: "default", "customized".
45+
- `url` (String) The URL associated with the custom page.
46+
3447

docs/data-sources/custom_pages_list.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,16 @@ data "cloudflare_custom_pages_list" "example_custom_pages_list" {
3434
<a id="nestedatt--result"></a>
3535
### Nested Schema for `result`
3636

37+
Read-Only:
38+
39+
- `created_on` (String)
40+
- `description` (String)
41+
- `id` (String)
42+
- `modified_on` (String)
43+
- `preview_target` (String)
44+
- `required_tokens` (List of String)
45+
- `state` (String) The custom page state.
46+
Available values: "default", "customized".
47+
- `url` (String) The URL associated with the custom page.
48+
3749

docs/data-sources/dns_record.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ data "cloudflare_dns_record" "example_dns_record" {
4040
- `id` (String) Identifier.
4141
- `meta` (String) Extra Cloudflare-specific information about the record.
4242
- `modified_on` (String) When the record was last modified.
43-
- `name` (String) DNS record name (or @ for the zone apex) in Punycode.
43+
- `name` (String) Complete DNS record name, including the zone name, in Punycode.
4444
- `priority` (Number) Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
4545
- `proxiable` (Boolean) Whether the record can be proxied by Cloudflare or not.
4646
- `proxied` (Boolean) Whether the record is receiving the performance and security benefits of Cloudflare.

docs/data-sources/dns_records.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Read-Only:
139139
- `id` (String) Identifier.
140140
- `meta` (String) Extra Cloudflare-specific information about the record.
141141
- `modified_on` (String) When the record was last modified.
142-
- `name` (String) DNS record name (or @ for the zone apex) in Punycode.
142+
- `name` (String) Complete DNS record name, including the zone name, in Punycode.
143143
- `priority` (Number) Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
144144
- `proxiable` (Boolean) Whether the record can be proxied by Cloudflare or not.
145145
- `proxied` (Boolean) Whether the record is receiving the performance and security benefits of Cloudflare.

docs/data-sources/email_security_block_sender.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Optional:
4949
Available values: "asc", "desc".
5050
- `order` (String) The field to sort by.
5151
Available values: "pattern", "created_at".
52+
- `pattern` (String)
5253
- `pattern_type` (String) Available values: "EMAIL", "DOMAIN", "IP", "UNKNOWN".
5354
- `search` (String) Allows searching in multiple properties of a record simultaneously.
5455
This parameter is intended for human users, not automation. Its exact

docs/data-sources/email_security_block_senders.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ data "cloudflare_email_security_block_senders" "example_email_security_block_sen
1616
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
1717
direction = "asc"
1818
order = "pattern"
19+
pattern = "pattern"
1920
pattern_type = "EMAIL"
2021
search = "search"
2122
}
@@ -35,6 +36,7 @@ Available values: "asc", "desc".
3536
- `max_items` (Number) Max items to fetch, default: 1000
3637
- `order` (String) The field to sort by.
3738
Available values: "pattern", "created_at".
39+
- `pattern` (String)
3840
- `pattern_type` (String) Available values: "EMAIL", "DOMAIN", "IP", "UNKNOWN".
3941
- `search` (String) Allows searching in multiple properties of a record simultaneously.
4042
This parameter is intended for human users, not automation. Its exact

docs/data-sources/email_security_trusted_domains.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Available values: "asc", "desc".
5555
- `is_similarity` (Boolean)
5656
- `order` (String) The field to sort by.
5757
Available values: "pattern", "created_at".
58+
- `pattern` (String)
5859
- `search` (String) Allows searching in multiple properties of a record simultaneously.
5960
This parameter is intended for human users, not automation. Its exact
6061
behavior is intentionally left unspecified and is subject to change

docs/data-sources/email_security_trusted_domains_list.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ data "cloudflare_email_security_trusted_domains_list" "example_email_security_tr
1818
is_recent = true
1919
is_similarity = true
2020
order = "pattern"
21+
pattern = "pattern"
2122
search = "search"
2223
}
2324
```
@@ -38,6 +39,7 @@ Available values: "asc", "desc".
3839
- `max_items` (Number) Max items to fetch, default: 1000
3940
- `order` (String) The field to sort by.
4041
Available values: "pattern", "created_at".
42+
- `pattern` (String)
4143
- `search` (String) Allows searching in multiple properties of a record simultaneously.
4244
This parameter is intended for human users, not automation. Its exact
4345
behavior is intentionally left unspecified and is subject to change

docs/data-sources/image.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ data "cloudflare_image" "example_image" {
2828

2929
### Read-Only
3030

31+
- `creator` (String) Can set the creator field with an internal user ID.
3132
- `filename` (String) Image file name.
3233
- `id` (String) Image unique identifier.
3334
- `meta` (String) User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.

0 commit comments

Comments
 (0)