Skip to content

Commit 0c7deeb

Browse files
committed
chore: fix required flag in docs and update wording from provider
1 parent 6987202 commit 0c7deeb

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -844,13 +844,11 @@ This is due to some terraform limitation and we will update the module once terr
844844

845845
- [**`key_prefix`**](#attr-autolink_references-key_prefix): *(**Required** `string`)*<a name="attr-autolink_references-key_prefix"></a>
846846

847-
The key prefix of the autolink reference.
847+
This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
848848

849-
- [**`target_url_template`**](#attr-autolink_references-target_url_template): *(Optional `string`)*<a name="attr-autolink_references-target_url_template"></a>
849+
- [**`target_url_template`**](#attr-autolink_references-target_url_template): *(**Required** `string`)*<a name="attr-autolink_references-target_url_template"></a>
850850

851-
The target url template of the autolink reference.
852-
853-
Default is `""`.
851+
The template of the target URL used for the links; must be a valid URL and contain `<num>` for the reference number.
854852

855853
### Module Configuration
856854

README.tfdoc.hcl

+3-3
Original file line numberDiff line numberDiff line change
@@ -1096,15 +1096,15 @@ section {
10961096
required = true
10971097
type = string
10981098
description = <<-END
1099-
The key prefix of the autolink reference.
1099+
This prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
11001100
END
11011101
}
11021102

11031103
attribute "target_url_template" {
1104+
required = true
11041105
type = string
1105-
default = ""
11061106
description = <<-END
1107-
The target url template of the autolink reference.
1107+
The template of the target URL used for the links; must be a valid URL and contain `<num>` for the reference number.
11081108
END
11091109
}
11101110
}

0 commit comments

Comments
 (0)