Skip to content

Commit 188ffef

Browse files
authored
chore: calrify the format of url for coder_app resource (#145)
* chore: calrify the format of `url` for `coder_app` resource A user has suggested to clarify the format of `url` in `coder_app` resource. See : coder/coder#8574 (comment) for related discussion. * Update app.go * make gen * Update app.go * make gen
1 parent 9ff00d6 commit 188ffef

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

Diff for: docs/resources/app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ resource "coder_app" "intellij" {
7676
- `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.
7777
- `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).
7878
- `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.
79-
- `url` (String) A URL to be proxied to from inside the workspace. Either "command" or "url" may be specified, but not both.
79+
- `url` (String) A URL to be proxied to from inside the workspace. This should be of the form "http://localhost:PORT[/SUBPATH]". Either "command" or "url" may be specified, but not both.
8080

8181
### Read-Only
8282

Diff for: provider/app.go

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ func appResource() *schema.Resource {
151151
"url": {
152152
Type: schema.TypeString,
153153
Description: "A URL to be proxied to from inside the workspace. " +
154+
"This should be of the form \"http://localhost:PORT[/SUBPATH]\". " +
154155
"Either \"command\" or \"url\" may be specified, but not both.",
155156
ForceNew: true,
156157
Optional: true,

0 commit comments

Comments
 (0)