From a25d114a5c35c66cf06f6a7ea844535d62d09713 Mon Sep 17 00:00:00 2001
From: Loren Gordon <lorengordon@users.noreply.github.com>
Date: Mon, 20 Jul 2020 10:43:27 -0700
Subject: [PATCH] Adds descriptions to `repos` variables

---
 README.md                 | 2 +-
 modules/defs/README.md    | 2 +-
 modules/defs/variables.tf | 2 +-
 modules/repo/README.md    | 2 +-
 modules/repo/variables.tf | 2 +-
 variables.tf              | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 35ff9f0..00f2198 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ No provider.
 |------|-------------|------|---------|:--------:|
 | bucket\_name | S3 bucket where salt repo will be mirrored | `string` | n/a | yes |
 | repo\_endpoint | HTTP/S endpoint URL that hosts the yum repos; used with the baseurl in the yum .repo definitions | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>    yum_prefix       = string<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. `yum_prefix` is the S3 key prefix for the yum repo definition files. | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>    yum_prefix       = string<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 
diff --git a/modules/defs/README.md b/modules/defs/README.md
index 93a2304..f236b34 100644
--- a/modules/defs/README.md
+++ b/modules/defs/README.md
@@ -15,7 +15,7 @@ No requirements.
 |------|-------------|------|---------|:--------:|
 | bucket\_name | n/a | `string` | n/a | yes |
 | repo\_endpoint | n/a | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix   = string<br>    salt_versions = list(string)<br>    yum_prefix    = string<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo is located. `salt_versions` is the list of salt versions for which repo definitions will be generated. `yum_prefix` is the S3 key prefix for the yum repo definition files. | <pre>list(object({<br>    repo_prefix   = string<br>    salt_versions = list(string)<br>    yum_prefix    = string<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 
diff --git a/modules/defs/variables.tf b/modules/defs/variables.tf
index 9b7dc6e..3d41065 100644
--- a/modules/defs/variables.tf
+++ b/modules/defs/variables.tf
@@ -7,10 +7,10 @@ variable "repo_endpoint" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo is located. `salt_versions` is the list of salt versions for which repo definitions will be generated. `yum_prefix` is the S3 key prefix for the yum repo definition files."
   type = list(object({
     repo_prefix   = string
     salt_versions = list(string)
     yum_prefix    = string
   }))
-  default = []
 }
diff --git a/modules/repo/README.md b/modules/repo/README.md
index ee0394c..85210fc 100644
--- a/modules/repo/README.md
+++ b/modules/repo/README.md
@@ -14,7 +14,7 @@ No requirements.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | bucket\_name | n/a | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 
diff --git a/modules/repo/variables.tf b/modules/repo/variables.tf
index ba8937a..e3471f6 100644
--- a/modules/repo/variables.tf
+++ b/modules/repo/variables.tf
@@ -3,10 +3,10 @@ variable "bucket_name" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror."
   type = list(object({
     repo_prefix      = string
     salt_s3_endpoint = string
     salt_versions    = list(string)
   }))
-  default = []
 }
diff --git a/variables.tf b/variables.tf
index c1a107f..80e2996 100644
--- a/variables.tf
+++ b/variables.tf
@@ -9,11 +9,11 @@ variable "repo_endpoint" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. `yum_prefix` is the S3 key prefix for the yum repo definition files."
   type = list(object({
     repo_prefix      = string
     salt_s3_endpoint = string
     salt_versions    = list(string)
     yum_prefix       = string
   }))
-  default = []
 }