Skip to content

Commit

Permalink
make docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz committed Dec 11, 2024
1 parent 1acafec commit 25b478a
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/resources/snippet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
page_title: "cloudflare_snippet Resource - Cloudflare"
subcategory: ""
description: |-
The Snippet https://developers.cloudflare.com/rules/snippets/ resource allows you to create and manage snippet for a zone.
---

# cloudflare_snippet (Resource)

The [Snippet](https://developers.cloudflare.com/rules/snippets/) resource allows you to create and manage snippet for a zone.


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

### Required

- `main_module` (String) Main module file name of the snippet.
- `name` (String) Name of the snippet.
- `zone_id` (String) The zone identifier to target for the resource.

### Optional

- `files` (Block Set) List of Snippet Files (see [below for nested schema](#nestedblock--files))

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

Required:

- `name` (String) Name of the snippet file.

Optional:

- `content` (String) Content of the snippet file.


37 changes: 37 additions & 0 deletions docs/resources/snippet_rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
page_title: "cloudflare_snippet_rules Resource - Cloudflare"
subcategory: ""
description: |-
The Snippet Rules https://developers.cloudflare.com/rules/snippets/ resource allows you to create and manage snippet rules for a zone.
---

# cloudflare_snippet_rules (Resource)

The [Snippet Rules](https://developers.cloudflare.com/rules/snippets/) resource allows you to create and manage snippet rules for a zone.


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

### Required

- `zone_id` (String) The zone identifier to target for the resource.

### Optional

- `rules` (Block Set) List of Snippet Rules (see [below for nested schema](#nestedblock--rules))

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

Required:

- `expression` (String) Criteria for an HTTP request to trigger the snippet rule. Uses the Firewall Rules expression language based on Wireshark display filters.
- `snippet_name` (String) Name of the snippet invoked by this rule.

Optional:

- `description` (String) Brief summary of the snippet rule and its intended use.
- `enabled` (Boolean) Whether the headers rule is active.


0 comments on commit 25b478a

Please sign in to comment.