Skip to content

Commit 06da9ec

Browse files
authored
chore: fix app share parameter description (#63)
1 parent 6adf9b4 commit 06da9ec

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

Diff for: docs/resources/app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ resource "coder_app" "intellij" {
6868
- `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/icons. Use a built-in icon with `data.coder_workspace.me.access_url + "/icons/<path>"`.
6969
- `name` (String) A display name to identify the app.
7070
- `relative_path` (Boolean, Deprecated) Specifies whether the URL will be accessed via a relative path or wildcard. Use if wildcard routing is unavailable. Defaults to true.
71-
- `share` (String) Application sharing is an enterprise feature and any values will be ignored (and sharing disabled) if your deployment is not entitled to use application sharing. Valid values are "owner", "template", "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "template" shares the app with all users that can read the workspace's template. 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 via a flag on "coder server". Defaults to "owner" (sharing disabled).
71+
- `share` (String) Determines the "level" which the application is shared at. Valid levels are "owner" (default), "template", "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "template" shares the app with users that can read the workspace's template. 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).
7272
- `subdomain` (Boolean) Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with "subdomain" set to true will not be accessible. Defaults to false.
7373
- `url` (String) A URL to be proxied to from inside the workspace. Either "command" or "url" may be specified, but not both.
7474

Diff for: provider/app.go

+11-13
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,17 @@ func appResource() *schema.Resource {
7979
},
8080
"share": {
8181
Type: schema.TypeString,
82-
Description: "Application sharing is an enterprise feature " +
83-
"and any values will be ignored (and sharing disabled) " +
84-
"if your deployment is not entitled to use application " +
85-
`sharing. Valid values are "owner", "template", ` +
86-
`"authenticated" and "public". Level "owner" disables ` +
87-
"sharing on the app, so only the workspace owner can " +
88-
`access it. Level "template" shares the app with all users ` +
89-
`that can read the workspace's template. Level ` +
90-
`"authenticated" shares the app with all authenticated ` +
91-
`users. Level "public" shares it with any user, ` +
92-
"including unauthenticated users. Permitted application " +
93-
`sharing levels can be configured via a flag on "coder ` +
94-
`server". Defaults to "owner" (sharing disabled).`,
82+
Description: `Determines the "level" which the application ` +
83+
`is shared at. Valid levels are "owner" (default), ` +
84+
`"template", "authenticated" and "public". Level "owner" ` +
85+
"disables sharing on the app, so only the workspace " +
86+
`owner can access it. Level "template" shares the app ` +
87+
"with users that can read the workspace's template. " +
88+
`Level "authenticated" shares the app with all ` +
89+
`authenticated users. Level "public" shares it with any ` +
90+
"user, including unauthenticated users. Permitted " +
91+
"application sharing levels can be configured site-wide " +
92+
`via a flag on "coder server" (Enterprise only).`,
9593
ForceNew: true,
9694
Optional: true,
9795
Default: "owner",

0 commit comments

Comments
 (0)