From 3ddf21c6430b233586dfad90212a6c51302a2978 Mon Sep 17 00:00:00 2001 From: Danielle Maywood <danielle@coder.com> Date: Mon, 9 Sep 2024 11:39:40 +0000 Subject: [PATCH 1/3] docs: document minimum version required for 'hidden' attribute --- docs/resources/app.md | 2 +- provider/app.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/resources/app.md b/docs/resources/app.md index ab44bede..3a51dc8d 100644 --- a/docs/resources/app.md +++ b/docs/resources/app.md @@ -63,7 +63,7 @@ resource "coder_app" "vim" { - `display_name` (String) A display name to identify the app. Defaults to the slug. - `external` (Boolean) Specifies whether `url` is opened on the client machine instead of proxied through the workspace. - `healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck)) -- `hidden` (Boolean) Determines if the app is visible in the UI. +- `hidden` (Boolean) Determines if the app is visible in the UI (minimum coder version: v2.16). - `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>"`. - `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). - `share` (String) Determines the level which the application is shared at. Valid levels are `"owner"` (default), `"authenticated"` and `"public"`. Level `"owner"` disables sharing on the app, so only the workspace owner can access it. Level `"authenticated"` shares the app with all authenticated users. Level `"public"` shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on `coder server` (Enterprise only). diff --git a/provider/app.go b/provider/app.go index 10f946c7..8453432e 100644 --- a/provider/app.go +++ b/provider/app.go @@ -218,7 +218,7 @@ func appResource() *schema.Resource { }, "hidden": { Type: schema.TypeBool, - Description: "Determines if the app is visible in the UI.", + Description: "Determines if the app is visible in the UI (minimum coder version: v2.16).", Default: false, ForceNew: true, Optional: true, From 30b80cb0687aced0bc0e9c4c159aa39aebab60ac Mon Sep 17 00:00:00 2001 From: Danielle Maywood <danielle@themaywoods.com> Date: Mon, 9 Sep 2024 12:47:46 +0100 Subject: [PATCH 2/3] fix: capitalize coder Co-authored-by: Cian Johnston <cian@coder.com> --- provider/app.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/provider/app.go b/provider/app.go index 8453432e..3fd71692 100644 --- a/provider/app.go +++ b/provider/app.go @@ -218,7 +218,7 @@ func appResource() *schema.Resource { }, "hidden": { Type: schema.TypeBool, - Description: "Determines if the app is visible in the UI (minimum coder version: v2.16).", + Description: "Determines if the app is visible in the UI (minimum Coder version: v2.16).", Default: false, ForceNew: true, Optional: true, From 036aff9f061213c1032ddf6d56de2667635af2b5 Mon Sep 17 00:00:00 2001 From: Danielle Maywood <danielle@coder.com> Date: Mon, 9 Sep 2024 11:50:56 +0000 Subject: [PATCH 3/3] fix: apply 'make gen' --- docs/resources/app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/app.md b/docs/resources/app.md index 3a51dc8d..6b8e99f4 100644 --- a/docs/resources/app.md +++ b/docs/resources/app.md @@ -63,7 +63,7 @@ resource "coder_app" "vim" { - `display_name` (String) A display name to identify the app. Defaults to the slug. - `external` (Boolean) Specifies whether `url` is opened on the client machine instead of proxied through the workspace. - `healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck)) -- `hidden` (Boolean) Determines if the app is visible in the UI (minimum coder version: v2.16). +- `hidden` (Boolean) Determines if the app is visible in the UI (minimum Coder version: v2.16). - `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>"`. - `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). - `share` (String) Determines the level which the application is shared at. Valid levels are `"owner"` (default), `"authenticated"` and `"public"`. Level `"owner"` disables sharing on the app, so only the workspace owner can access it. Level `"authenticated"` shares the app with all authenticated users. Level `"public"` shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on `coder server` (Enterprise only).