Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Wholey committed Nov 20, 2023
1 parent b1a54de commit 4e1c054
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 61 deletions.
13 changes: 4 additions & 9 deletions docs/data-sources/cname_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,15 @@ data "pihole_cname_records" "records" {}
<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **records** (Set of Object) List of CNAME Pi-hole records (see [below for nested schema](#nestedatt--records))
- `id` (String) The ID of this resource.
- `records` (Set of Object) List of CNAME Pi-hole records (see [below for nested schema](#nestedatt--records))

<a id="nestedatt--records"></a>
### Nested Schema for `records`

Read-Only:

- **domain** (String)
- **target** (String)


- `domain` (String)
- `target` (String)
13 changes: 4 additions & 9 deletions docs/data-sources/dns_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,15 @@ data "pihole_dns_records" "records" {}
<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **records** (Set of Object) List of Pi-hole DNS records (see [below for nested schema](#nestedatt--records))
- `id` (String) The ID of this resource.
- `records` (Set of Object) List of Pi-hole DNS records (see [below for nested schema](#nestedatt--records))

<a id="nestedatt--records"></a>
### Nested Schema for `records`

Read-Only:

- **domain** (String)
- **ip** (String)


- `domain` (String)
- `ip` (String)
22 changes: 10 additions & 12 deletions docs/data-sources/domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,22 @@ data "pihole_domains" "denied" {

### Optional

- **id** (String) The ID of this resource.
- **type** (String) Filter on allowed or denied domains. Must be either 'allow' or 'deny'.
- `type` (String) Filter on allowed or denied domains. Must be either 'allow' or 'deny'.

### Read-Only

- **domains** (Set of Object) Domains (see [below for nested schema](#nestedatt--domains))
- `domains` (Set of Object) Domains (see [below for nested schema](#nestedatt--domains))
- `id` (String) The ID of this resource.

<a id="nestedatt--domains"></a>
### Nested Schema for `domains`

Read-Only:

- **comment** (String)
- **domain** (String)
- **enabled** (Boolean)
- **group_ids** (List of Number)
- **id** (Number)
- **type** (String)
- **wildcard** (Boolean)


- `comment` (String)
- `domain` (String)
- `enabled` (Boolean)
- `group_ids` (List of Number)
- `id` (Number)
- `type` (String)
- `wildcard` (Boolean)
17 changes: 6 additions & 11 deletions docs/data-sources/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,17 @@ data "pihole_cname_records" "records" {}
<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **groups** (Set of Object) List of groups to manage client lists and block lists (see [below for nested schema](#nestedatt--groups))
- `groups` (Set of Object) List of groups to manage client lists and block lists (see [below for nested schema](#nestedatt--groups))
- `id` (String) The ID of this resource.

<a id="nestedatt--groups"></a>
### Nested Schema for `groups`

Read-Only:

- **description** (String)
- **enabled** (Boolean)
- **id** (Number)
- **name** (String)


- `description` (String)
- `enabled` (Boolean)
- `id` (Number)
- `name` (String)
7 changes: 4 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ provider "pihole" {

### Optional

- **api_token** (String) Experimental: Pi-hole API token. Conflicts with `password`.
- **password** (String) The admin password used to login to the admin dashboard. Conflicts with `api_token`.
- **url** (String) URL where Pi-hole is deployed
- `api_token` (String) Experimental: Pi-hole API token. Conflicts with `password`.
- `ca_file` (String) CA file to connect to Pi-hole with TLS
- `password` (String) The admin password used to login to the admin dashboard. Conflicts with `api_token`.
- `url` (String) URL where Pi-hole is deployed
8 changes: 3 additions & 5 deletions docs/resources/ad_blocker_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,8 @@ resource "pihole_ad_blocker_status" "status" {

### Required

- **enabled** (Boolean) Whether to enable the Pi-hole ad blocker

### Optional

- **id** (String) The ID of this resource.
- `enabled` (Boolean) Whether to enable the Pi-hole ad blocker

### Read-Only

- `id` (String) The ID of this resource.
8 changes: 4 additions & 4 deletions docs/resources/cname_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ resource "pihole_cname_record" "record" {

### Required

- **domain** (String) Domain to create a CNAME record for
- **target** (String) Value of the CNAME record where traffic will be directed to from the configured domain value
- `domain` (String) Domain to create a CNAME record for
- `target` (String) Value of the CNAME record where traffic will be directed to from the configured domain value

### Optional
### Read-Only

- **id** (String) The ID of this resource.
- `id` (String) The ID of this resource.

## Import

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/dns_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ resource "pihole_dns_record" "record" {

### Required

- **domain** (String) DNS record domain
- **ip** (String) IP address to route traffic to from the DNS record domain
- `domain` (String) DNS record domain
- `ip` (String) IP address to route traffic to from the DNS record domain

### Optional
### Read-Only

- **id** (String) The ID of this resource.
- `id` (String) The ID of this resource.

## Import

Expand Down
11 changes: 7 additions & 4 deletions docs/resources/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,16 @@ resource "pihole_group" "group" {

### Required

- **name** (String) Group name
- `name` (String) Group name

### Optional

- **description** (String) Group description
- **enabled** (Boolean) Whether to enable the group
- **id** (String) The ID of this resource.
- `description` (String) Group description
- `enabled` (Boolean) Whether to enable the group

### Read-Only

- `id` (String) The ID of this resource.

## Import

Expand Down

0 comments on commit 4e1c054

Please sign in to comment.