Skip to content

Commit

Permalink
backport(docs): document minimum version required for 'hidden' attrib…
Browse files Browse the repository at this point in the history
…ute (#286)

* docs: document minimum version required for 'hidden' attribute

(cherry picked from commit ef40a58)

* fix: capitalize coder

Co-authored-by: Cian Johnston <cian@coder.com>
(cherry picked from commit 30b80cb)

* fix: apply 'make gen'

(cherry picked from commit 036aff9)
  • Loading branch information
DanielleMaywood authored Sep 9, 2024
1 parent fccc10b commit 0aeb8ad
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/resources/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>"`.
- `name` (String, **Deprecated**: `name` on apps is deprecated, use `display_name` instead) A display name to identify the app.
- `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).
Expand Down
2 changes: 1 addition & 1 deletion provider/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,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,
Expand Down

0 comments on commit 0aeb8ad

Please sign in to comment.