Skip to content

Commit 0aeb8ad

Browse files
backport(docs): document minimum version required for 'hidden' attribute (#286)
* docs: document minimum version required for 'hidden' attribute (cherry picked from commit ef40a58) * fix: capitalize coder Co-authored-by: Cian Johnston <[email protected]> (cherry picked from commit 30b80cb) * fix: apply 'make gen' (cherry picked from commit 036aff9)
1 parent fccc10b commit 0aeb8ad

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ resource "coder_app" "vim" {
6363
- `display_name` (String) A display name to identify the app. Defaults to the slug.
6464
- `external` (Boolean) Specifies whether `url` is opened on the client machine instead of proxied through the workspace.
6565
- `healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck))
66-
- `hidden` (Boolean) Determines if the app is visible in the UI.
66+
- `hidden` (Boolean) Determines if the app is visible in the UI (minimum Coder version: v2.16).
6767
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `"${data.coder_workspace.me.access_url}/icon/<path>"`.
6868
- `name` (String, **Deprecated**: `name` on apps is deprecated, use `display_name` instead) A display name to identify the app.
6969
- `order` (Number) The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).

provider/app.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ func appResource() *schema.Resource {
235235
},
236236
"hidden": {
237237
Type: schema.TypeBool,
238-
Description: "Determines if the app is visible in the UI.",
238+
Description: "Determines if the app is visible in the UI (minimum Coder version: v2.16).",
239239
Default: false,
240240
ForceNew: true,
241241
Optional: true,

0 commit comments

Comments
 (0)