From dbaa1db479b26246ef2ea82640221d6d69caad2d Mon Sep 17 00:00:00 2001 From: Carlos Latorre Date: Fri, 22 Mar 2024 12:02:02 +0100 Subject: [PATCH] Adding docs to provider --- docs/data-sources/setup_endpoint.md | 29 ++++++ docs/data-sources/setup_linkedip.md | 28 ++++++ docs/index.md | 20 ++++ docs/resources/allowlist.md | 36 +++++++ docs/resources/denylist.md | 36 +++++++ docs/resources/parental_control.md | 139 ++++++++++++++++++++++++++++ docs/resources/privacy.md | 31 +++++++ docs/resources/profile.md | 25 +++++ docs/resources/rewrite.md | 33 +++++++ docs/resources/security.md | 40 ++++++++ docs/resources/settings.md | 65 +++++++++++++ 11 files changed, 482 insertions(+) create mode 100644 docs/data-sources/setup_endpoint.md create mode 100644 docs/data-sources/setup_linkedip.md create mode 100644 docs/index.md create mode 100644 docs/resources/allowlist.md create mode 100644 docs/resources/denylist.md create mode 100644 docs/resources/parental_control.md create mode 100644 docs/resources/privacy.md create mode 100644 docs/resources/profile.md create mode 100644 docs/resources/rewrite.md create mode 100644 docs/resources/security.md create mode 100644 docs/resources/settings.md diff --git a/docs/data-sources/setup_endpoint.md b/docs/data-sources/setup_endpoint.md new file mode 100644 index 0000000..ee5614b --- /dev/null +++ b/docs/data-sources/setup_endpoint.md @@ -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 + +### 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. diff --git a/docs/data-sources/setup_linkedip.md b/docs/data-sources/setup_linkedip.md new file mode 100644 index 0000000..5780e9e --- /dev/null +++ b/docs/data-sources/setup_linkedip.md @@ -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 + +### 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. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..17c2528 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "nextdns Provider" +subcategory: "" +description: |- + +--- + +# nextdns Provider + + + + + + +## Schema + +### Optional + +- `api_key` (String) NextDNS API Key diff --git a/docs/resources/allowlist.md b/docs/resources/allowlist.md new file mode 100644 index 0000000..104c75c --- /dev/null +++ b/docs/resources/allowlist.md @@ -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 + +### 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. + + +### Nested Schema for `domain` + +Required: + +- `active` (Boolean) + +Read-Only: + +- `id` (String) The ID of this resource. diff --git a/docs/resources/denylist.md b/docs/resources/denylist.md new file mode 100644 index 0000000..b413c9e --- /dev/null +++ b/docs/resources/denylist.md @@ -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 + +### 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. + + +### Nested Schema for `domain` + +Required: + +- `active` (Boolean) + +Read-Only: + +- `id` (String) The ID of this resource. diff --git a/docs/resources/parental_control.md b/docs/resources/parental_control.md new file mode 100644 index 0000000..2d8a05f --- /dev/null +++ b/docs/resources/parental_control.md @@ -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 + +### 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. + + +### Nested Schema for `category` + +Required: + +- `active` (Boolean) +- `recreation` (Boolean) + +Read-Only: + +- `id` (String) The ID of this resource. + + + +### 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)) + + +### Nested Schema for `recreation.friday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.monday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.saturday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.sunday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.thursday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.tuesday` + +Required: + +- `end` (String) +- `start` (String) + + + +### Nested Schema for `recreation.wednesday` + +Required: + +- `end` (String) +- `start` (String) + + + + +### Nested Schema for `service` + +Required: + +- `active` (Boolean) +- `recreation` (Boolean) + +Read-Only: + +- `id` (String) The ID of this resource. diff --git a/docs/resources/privacy.md b/docs/resources/privacy.md new file mode 100644 index 0000000..a07abf7 --- /dev/null +++ b/docs/resources/privacy.md @@ -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 + +### 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. diff --git a/docs/resources/profile.md b/docs/resources/profile.md new file mode 100644 index 0000000..c28629d --- /dev/null +++ b/docs/resources/profile.md @@ -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 + +### Required + +- `name` (String) Profile name. + +### Read-Only + +- `id` (String) The ID of this resource. +- `profile_id` (String) The profile identifier to target the resource. diff --git a/docs/resources/rewrite.md b/docs/resources/rewrite.md new file mode 100644 index 0000000..bc22548 --- /dev/null +++ b/docs/resources/rewrite.md @@ -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 + +### 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. + + +### Nested Schema for `rewrite` + +Required: + +- `address` (String) +- `domain` (String) diff --git a/docs/resources/security.md b/docs/resources/security.md new file mode 100644 index 0000000..b87a24d --- /dev/null +++ b/docs/resources/security.md @@ -0,0 +1,40 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "nextdns_security Resource - terraform-provider-nextdns" +subcategory: "" +description: |- + +--- + +# nextdns_security (Resource) + + + + + + +## Schema + +### Required + +- `ai_threat_detection` (Boolean) AI-Driven threat detection. +- `crypto_jacking` (Boolean) Cryptojacking protection. +- `csam` (Boolean) Block child sexual abuse material. +- `ddns` (Boolean) Block dynamic DNS hostnames. +- `dga` (Boolean) Domain generation algorithms (DGAs) protection. +- `dns_rebinding` (Boolean) DNS rebinding protection. +- `google_safe_browsing` (Boolean) Google safe browsing. +- `idn_homographs` (Boolean) IDN homograph attacks protection. +- `nrd` (Boolean) Block newly registered domains (NRDs). +- `parking` (Boolean) Block parked domains. +- `profile_id` (String) The profile identifier to target the resource. +- `threat_intelligence_feeds` (Boolean) Threat intelligence feeds. +- `typo_squatting` (Boolean) Typosquatting protection. + +### Optional + +- `tlds` (List of String) Block top-level domains (TLDs). + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/settings.md b/docs/resources/settings.md new file mode 100644 index 0000000..0e5e286 --- /dev/null +++ b/docs/resources/settings.md @@ -0,0 +1,65 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "nextdns_settings Resource - terraform-provider-nextdns" +subcategory: "" +description: |- + +--- + +# nextdns_settings (Resource) + + + + + + +## Schema + +### Required + +- `block_page` (Block List, Min: 1) Block Page. (see [below for nested schema](#nestedblock--block_page)) +- `logs` (Block List, Min: 1) Logs. (see [below for nested schema](#nestedblock--logs)) +- `performance` (Block List, Min: 1) Performance. (see [below for nested schema](#nestedblock--performance)) +- `profile_id` (String) The profile identifier to target the resource. +- `web3` (Boolean) Web3. + +### Read-Only + +- `id` (String) The ID of this resource. + + +### Nested Schema for `block_page` + +Required: + +- `enabled` (Boolean) Enable block page. + + + +### Nested Schema for `logs` + +Required: + +- `enabled` (Boolean) Enable logs. +- `location` (String) Location of the logs. +- `privacy` (Block List, Min: 1) (see [below for nested schema](#nestedblock--logs--privacy)) +- `retention` (String) Retention period for logs. + + +### Nested Schema for `logs.privacy` + +Required: + +- `log_clients_ip` (Boolean) Log clients IP. +- `log_domains` (Boolean) Log domains. + + + + +### Nested Schema for `performance` + +Required: + +- `cache_boost` (Boolean) Cache Boost. +- `cname_flattening` (Boolean) CNAME Flattening. +- `ecs` (Boolean) Anonymized EDNS Client Subnet.