Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding docs to provider #22

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Adding docs to provider
carbans committed Mar 22, 2024
commit dbaa1db479b26246ef2ea82640221d6d69caad2d
29 changes: 29 additions & 0 deletions docs/data-sources/setup_endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_setup_endpoint Data Source - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_setup_endpoint (Data Source)





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

### Required

- `profile_id` (String) The profile identifier to target the resource.

### Read-Only

- `dnscrypt` (String) The DNS Stamps from the profile.
- `doh` (String) The DNS over HTTPS address the profile is reachable at.
- `dot` (String) The DNS over TLS address the profile is reachable at.
- `id` (String) The ID of this resource.
- `ipv4` (List of String) The IPv4 addresses the profile is reachable at.
- `ipv6` (List of String) The IPv6 addresses the profile is reachable at.
28 changes: 28 additions & 0 deletions docs/data-sources/setup_linkedip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_setup_linkedip Data Source - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_setup_linkedip (Data Source)





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

### Required

- `profile_id` (String) The profile identifier to target the resource.

### Read-Only

- `ddns` (String) The DDNS configuration for the linked IP.
- `id` (String) The ID of this resource.
- `ip` (String) The IP linked to the profile.
- `servers` (List of String) The DNS servers available for the profile.
- `update_token` (String) The update token to use to update the linked IP.
20 changes: 20 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns Provider"
subcategory: ""
description: |-

---

# nextdns Provider





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

### Optional

- `api_key` (String) NextDNS API Key
36 changes: 36 additions & 0 deletions docs/resources/allowlist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_allowlist Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_allowlist (Resource)





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

### Required

- `domain` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--domain))
- `profile_id` (String) The profile identifier to target the resource.

### Read-Only

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

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

Required:

- `active` (Boolean)

Read-Only:

- `id` (String) The ID of this resource.
36 changes: 36 additions & 0 deletions docs/resources/denylist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_denylist Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_denylist (Resource)





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

### Required

- `domain` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--domain))
- `profile_id` (String) The profile identifier to target the resource.

### Read-Only

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

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

Required:

- `active` (Boolean)

Read-Only:

- `id` (String) The ID of this resource.
139 changes: 139 additions & 0 deletions docs/resources/parental_control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_parental_control Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_parental_control (Resource)





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

### Required

- `block_bypass` (Boolean) Block bypass methods.
- `profile_id` (String) The profile identifier to target the resource.
- `safe_search` (Boolean) Safe search.
- `youtube_restricted_mode` (Boolean) YouTube restricted mode.

### Optional

- `category` (Block Set) Restrict access to specific categories of websites and apps. (see [below for nested schema](#nestedblock--category))
- `recreation` (Block List) Period for each day of the week during which some of the websites, apps, games or categories will not be blocked. (see [below for nested schema](#nestedblock--recreation))
- `service` (Block Set) Restrict access to specific websites, apps and games. (see [below for nested schema](#nestedblock--service))

### Read-Only

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

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

Required:

- `active` (Boolean)
- `recreation` (Boolean)

Read-Only:

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


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

Required:

- `timezone` (String)

Optional:

- `friday` (Block List) (see [below for nested schema](#nestedblock--recreation--friday))
- `monday` (Block List) (see [below for nested schema](#nestedblock--recreation--monday))
- `saturday` (Block List) (see [below for nested schema](#nestedblock--recreation--saturday))
- `sunday` (Block List) (see [below for nested schema](#nestedblock--recreation--sunday))
- `thursday` (Block List) (see [below for nested schema](#nestedblock--recreation--thursday))
- `tuesday` (Block List) (see [below for nested schema](#nestedblock--recreation--tuesday))
- `wednesday` (Block List) (see [below for nested schema](#nestedblock--recreation--wednesday))

<a id="nestedblock--recreation--friday"></a>
### Nested Schema for `recreation.friday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--monday"></a>
### Nested Schema for `recreation.monday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--saturday"></a>
### Nested Schema for `recreation.saturday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--sunday"></a>
### Nested Schema for `recreation.sunday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--thursday"></a>
### Nested Schema for `recreation.thursday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--tuesday"></a>
### Nested Schema for `recreation.tuesday`

Required:

- `end` (String)
- `start` (String)


<a id="nestedblock--recreation--wednesday"></a>
### Nested Schema for `recreation.wednesday`

Required:

- `end` (String)
- `start` (String)



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

Required:

- `active` (Boolean)
- `recreation` (Boolean)

Read-Only:

- `id` (String) The ID of this resource.
31 changes: 31 additions & 0 deletions docs/resources/privacy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_privacy Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_privacy (Resource)





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

### Required

- `allow_affiliate` (Boolean) Allow affiliate & tracking links.
- `disguised_trackers` (Boolean) Block disguised third-party trackers.
- `profile_id` (String) The profile identifier to target the resource.

### Optional

- `blocklists` (List of String) Blocklists.
- `natives` (List of String) Native tracking protection.

### Read-Only

- `id` (String) The ID of this resource.
25 changes: 25 additions & 0 deletions docs/resources/profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_profile Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_profile (Resource)





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

### Required

- `name` (String) Profile name.

### Read-Only

- `id` (String) The ID of this resource.
- `profile_id` (String) The profile identifier to target the resource.
33 changes: 33 additions & 0 deletions docs/resources/rewrite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "nextdns_rewrite Resource - terraform-provider-nextdns"
subcategory: ""
description: |-

---

# nextdns_rewrite (Resource)





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

### Required

- `profile_id` (String) The profile identifier to target the resource.
- `rewrite` (Block Set, Min: 1) (see [below for nested schema](#nestedblock--rewrite))

### Read-Only

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

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

Required:

- `address` (String)
- `domain` (String)
Loading