Skip to content

Commit

Permalink
chores(doc): Ensure all input variables have a description. (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
benoit-garcia authored Feb 4, 2023
1 parent af51f57 commit 20141ab
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ module "my_domain" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_domain"></a> [domain](#input_domain) | n/a | `string` | n/a | yes |
| <a name="input_mx_servers"></a> [mx_servers](#input_mx_servers) | n/a | ```list(object({ address = string priority = number }))``` | ```[ { "address": ".", "priority": 0 } ]``` | no |
| <a name="input_domain"></a> [domain](#input_domain) | Name of the domain to manage. | `string` | n/a | yes |
| <a name="input_mx_servers"></a> [mx_servers](#input_mx_servers) | Informations regarding MX servers. **MX servers are required to enable Transactional Emails.** | ```list(object({ address = string priority = number }))``` | ```[ { "address": ".", "priority": 0 } ]``` | no |
| <a name="input_project_id"></a> [project_id](#input_project_id) | ID of the project the domain is associated with. Ressource will be created in the project set at the provider level if null. | `string` | `null` | no |
| <a name="input_setup_tem"></a> [setup_tem](#input_setup_tem) | Whether to create a Transaction Email service. **Beware that the service is only available in region `fr-par` at the moment.** | `bool` | `false` | no |
| <a name="input_subdomain"></a> [subdomain](#input_subdomain) | n/a | `string` | `""` | no |
| <a name="input_subdomain"></a> [subdomain](#input_subdomain) | Name of the subdomain to manage. | `string` | `""` | no |

## Outputs

Expand Down
9 changes: 6 additions & 3 deletions variables.tf
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
variable "domain" {
type = string
description = "Name of the domain to manage."
type = string
}

variable "mx_servers" {
description = "Informations regarding MX servers. **MX servers are required to enable Transactional Emails.**"
type = list(object({
address = string
priority = number
Expand All @@ -20,8 +22,9 @@ variable "project_id" {
}

variable "subdomain" {
type = string
default = ""
description = "Name of the subdomain to manage."
type = string
default = ""
}

variable "setup_tem" {
Expand Down

0 comments on commit 20141ab

Please sign in to comment.