Skip to content

Commit

Permalink
Regenerating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nlewo committed Jan 13, 2022
1 parent f1c3dad commit c0d1d05
Show file tree
Hide file tree
Showing 10 changed files with 123 additions and 90 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Note: sharing_id is optional. It is used e.g. when the API key is registered to
terraform {
required_providers {
gandi = {
version = "2.0.0-rc3"
version = "~> 2.0.0"
source = "github/go-gandi/gandi"
}
}
Expand Down
31 changes: 31 additions & 0 deletions docs/data-sources/glue_record.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: "gandi_glue_record Data Source - terraform-provider-gandi"
subcategory: ""
description: |-
---

# gandi_glue_record (Data Source)





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

### Required

- **name** (String) Host name of the glue record
- **zone** (String) Domain name

### Optional

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

### Read-Only

- **ips** (List of String) A list of the ip addresses provided for the glue record


21 changes: 0 additions & 21 deletions docs/data-sources/gluerecord.md

This file was deleted.

19 changes: 2 additions & 17 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

The Gandi provider enables the purchasing and management of the
following Gandi resources:

- [DNS zones](https://api.gandi.net/docs/domains/)
- [LiveDNS service](https://api.gandi.net/docs/livedns/)
- [Email](https://api.gandi.net/docs/email/)
Expand All @@ -13,13 +14,11 @@ Use the navigation to the left to read about the available resources.

## Example Usage

Terraform 0.13 and later:

```terraform
terraform {
required_providers {
gandi = {
version = "~> 2.0"
version = "~> 2.0.0"
source = "go-gandi/gandi"
}
}
Expand All @@ -31,20 +30,6 @@ provider "gandi" {
resource "gandi_domain" "example_com" {
name = "example.com"
nameservers = ["a.dns.server"]
}
```

Terraform 0.12:

```terraform
provider "gandi" {
key = "MY_API_KEY"
}
resource "gandi_domain" "example_com" {
name = "example.com"
nameservers = ["a.dns.server"]
}
```

Expand Down
20 changes: 10 additions & 10 deletions docs/resources/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ description: |-

### Required

- **admin** (Block Set, Min: 1) (see [below for nested schema](#nestedblock--admin))
- **billing** (Block Set, Min: 1) (see [below for nested schema](#nestedblock--billing))
- **name** (String) The FQDN of the domain
- **owner** (Block Set, Min: 1) (see [below for nested schema](#nestedblock--owner))
- **tech** (Block Set, Min: 1) (see [below for nested schema](#nestedblock--tech))

### Optional

- **admin** (Block Set) (see [below for nested schema](#nestedblock--admin))
- **autorenew** (Boolean) Should the domain autorenew
- **billing** (Block Set) (see [below for nested schema](#nestedblock--billing))
- **id** (String) The ID of this resource.
- **nameservers** (List of String) A list of nameservers for the domain
- **nameservers** (List of String, Deprecated) A list of nameservers for the domain
- **tech** (Block Set) (see [below for nested schema](#nestedblock--tech))
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

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

Required:

Expand All @@ -54,8 +54,8 @@ Optional:
- **state** (String) The state code for the contact


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

Required:

Expand All @@ -78,8 +78,8 @@ Optional:
- **state** (String) The state code for the contact


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

Required:

Expand Down
42 changes: 42 additions & 0 deletions docs/resources/glue_record.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "gandi_glue_record Resource - terraform-provider-gandi"
subcategory: ""
description: |-
---

# gandi_glue_record (Resource)





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

### Required

- **ips** (List of String) List of IP addresses
- **name** (String) Host name of the glue record
- **zone** (String) Domain name

### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- **fqdn** (String) The fqdn of the record
- **fqdn_unicode** (String) The fqdn unicode of the record
- **href** (String) The href of the record

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

Optional:

- **default** (String)


23 changes: 0 additions & 23 deletions docs/resources/gluerecord.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/resources/livedns_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ description: |-
- **automatic_snapshots** (Boolean) Enable or disable the automatic creation of snapshots when records are changed
- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- **ttl** (Number) The SOA TTL for the domain
- **ttl** (Number, Deprecated) The SOA TTL for the domain

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`
Expand Down
35 changes: 35 additions & 0 deletions docs/resources/nameservers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "gandi_nameservers Resource - terraform-provider-gandi"
subcategory: ""
description: |-
---

# gandi_nameservers (Resource)





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

### Required

- **domain** (String) The FQDN of the domain

### Optional

- **id** (String) The ID of this resource.
- **nameservers** (List of String) A list of nameservers for the domain
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

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

Optional:

- **default** (String)


18 changes: 1 addition & 17 deletions templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ Use the navigation to the left to read about the available resources.

## Example Usage

Terraform 0.13 and later:

```terraform
terraform {
required_providers {
gandi = {
version = "~> 2.0"
version = "~> 2.0.0"
source = "go-gandi/gandi"
}
}
Expand All @@ -32,20 +30,6 @@ provider "gandi" {
resource "gandi_domain" "example_com" {
name = "example.com"
nameservers = ["a.dns.server"]
}
```

Terraform 0.12:

```terraform
provider "gandi" {
key = "MY_API_KEY"
}
resource "gandi_domain" "example_com" {
name = "example.com"
nameservers = ["a.dns.server"]
}
```

Expand Down

0 comments on commit c0d1d05

Please sign in to comment.