Skip to content

Commit

Permalink
Merge pull request #4723 from cloudflare/make-docs
Browse files Browse the repository at this point in the history
docs: run generation
  • Loading branch information
jacobbednarz authored Dec 6, 2024
2 parents 2b81a32 + e9b77c6 commit 2db239e
Show file tree
Hide file tree
Showing 438 changed files with 5,515 additions and 2,972 deletions.
9 changes: 9 additions & 0 deletions docs/data-sources/access_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ description: |-



## Example Usage

```terraform
data "cloudflare_access_rule" "example_access_rule" {
rule_id = "023e105f4ecef8ad9ca31a8372d0c353"
account_id = "account_id"
zone_id = "zone_id"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
16 changes: 16 additions & 0 deletions docs/data-sources/access_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ description: |-



## Example Usage

```terraform
data "cloudflare_access_rules" "example_access_rules" {
account_id = "account_id"
zone_id = "zone_id"
configuration = {
target = "ip"
value = "198.51.100.4"
}
direction = "asc"
mode = "block"
notes = "my note"
order = "configuration.target"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 7 additions & 0 deletions docs/data-sources/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account" "example_account" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/account_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_member" "example_account_member" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
member_id = "4536bcfad5faccb111b47003c79917fa"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
36 changes: 23 additions & 13 deletions docs/data-sources/account_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_members" "example_account_members" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
direction = "asc"
order = "user.first_name"
status = "accepted"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -59,7 +69,7 @@ Read-Only:
- `name` (String) Name of the group.

<a id="nestedatt--result--policies--permission_groups--meta"></a>
### Nested Schema for `result.policies.permission_groups.name`
### Nested Schema for `result.policies.permission_groups.meta`

Read-Only:

Expand All @@ -79,7 +89,7 @@ Read-Only:
- `scope` (Attributes List) The scope associated to the resource group (see [below for nested schema](#nestedatt--result--policies--resource_groups--scope))

<a id="nestedatt--result--policies--resource_groups--meta"></a>
### Nested Schema for `result.policies.resource_groups.scope`
### Nested Schema for `result.policies.resource_groups.meta`

Read-Only:

Expand Down Expand Up @@ -135,7 +145,7 @@ Read-Only:
- `zones` (Attributes) (see [below for nested schema](#nestedatt--result--roles--permissions--zones))

<a id="nestedatt--result--roles--permissions--analytics"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.analytics`

Read-Only:

Expand All @@ -144,7 +154,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--billing"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.billing`

Read-Only:

Expand All @@ -153,7 +163,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--cache_purge"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.cache_purge`

Read-Only:

Expand All @@ -162,7 +172,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--dns"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.dns`

Read-Only:

Expand All @@ -171,7 +181,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--dns_records"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.dns_records`

Read-Only:

Expand All @@ -180,7 +190,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--lb"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.lb`

Read-Only:

Expand All @@ -189,7 +199,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--logs"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.logs`

Read-Only:

Expand All @@ -198,7 +208,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--organization"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.organization`

Read-Only:

Expand All @@ -207,7 +217,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--ssl"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.ssl`

Read-Only:

Expand All @@ -216,7 +226,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--waf"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.waf`

Read-Only:

Expand All @@ -225,7 +235,7 @@ Read-Only:


<a id="nestedatt--result--roles--permissions--zone_settings"></a>
### Nested Schema for `result.roles.permissions.zones`
### Nested Schema for `result.roles.permissions.zone_settings`

Read-Only:

Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/account_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_role" "example_account_role" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
role_id = "3536bcfad5faccb999b47003c79917fb"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
20 changes: 3 additions & 17 deletions docs/data-sources/account_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,11 @@ description: |-
## Example Usage

```terraform
data "cloudflare_account_roles" "account_roles" {
account_id = "f037e56e89293a057740de681ac9abbe"
}
locals {
roles_by_name = {
for role in data.cloudflare_account_roles.account_roles.roles :
role.name => role
}
}
resource "cloudflare_account_member" "member" {
account_id = "f037e56e89293a057740de681ac9abbe"
email_address = "user@example.com"
role_ids = [
local.roles_by_name["Administrator"].id
]
data "cloudflare_account_roles" "example_account_roles" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
7 changes: 7 additions & 0 deletions docs/data-sources/account_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_subscription" "example_account_subscription" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/account_token.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_token" "example_account_token" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
token_id = "ed17574386854bf78a67040be0a770b0"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
10 changes: 9 additions & 1 deletion docs/data-sources/account_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_account_tokens" "example_account_tokens" {
account_id = "eb78d65290b24279ba6f44721b3ea3c4"
direction = "asc"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -79,7 +87,7 @@ Read-Only:
- `name` (String) Name of the group.

<a id="nestedatt--result--policies--permission_groups--meta"></a>
### Nested Schema for `result.policies.permission_groups.name`
### Nested Schema for `result.policies.permission_groups.meta`

Read-Only:

Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ description: |-
## Example Usage

```terraform
data "cloudflare_accounts" "example" {
name = "example account"
data "cloudflare_accounts" "example_accounts" {
direction = "asc"
name = "example.com"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/address_map.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_address_map" "example_address_map" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
address_map_id = "023e105f4ecef8ad9ca31a8372d0c353"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 7 additions & 0 deletions docs/data-sources/address_maps.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: |-



## Example Usage

```terraform
data "cloudflare_address_maps" "example_address_maps" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/api_shield.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_api_shield" "example_api_shield" {
zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
properties = ["auth_id_characteristics"]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
17 changes: 17 additions & 0 deletions docs/data-sources/api_shield_operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ description: |-



## Example Usage

```terraform
data "cloudflare_api_shield_operation" "example_api_shield_operation" {
zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
diff = true
direction = "asc"
endpoint = "/api/v1"
host = ["api.cloudflare.com"]
method = ["GET"]
order = "host"
origin = "ML"
page = 1
per_page = 5
state = "review"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ description: |-



## Example Usage

```terraform
data "cloudflare_api_shield_operation_schema_validation_settings" "example_api_shield_operation_schema_validation_settings" {
zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
operation_id = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
Loading

0 comments on commit 2db239e

Please sign in to comment.