From cc4f23151b2b0da2deb8639de24b0261724a222e Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 19 Jul 2023 14:45:09 +0300 Subject: [PATCH 1/5] 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 : https://github.com/coder/coder/discussions/8574#discussioncomment-6486344 for related discussion. --- provider/app.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/provider/app.go b/provider/app.go index 0d937dd0..f1f7d5dd 100644 --- a/provider/app.go +++ b/provider/app.go @@ -150,7 +150,7 @@ func appResource() *schema.Resource { }, "url": { Type: schema.TypeString, - Description: "A URL to be proxied to from inside the workspace. " + + Description: "A URL to be proxied to from inside the workspace. This hsould be of the form http://localhost:PORT[/SUBPATH]" + "Either \"command\" or \"url\" may be specified, but not both.", ForceNew: true, Optional: true, From 2874ffb5f9964815a72be0962b62ee61d2f65acc Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 19 Jul 2023 14:52:12 +0300 Subject: [PATCH 2/5] Update app.go --- provider/app.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/provider/app.go b/provider/app.go index f1f7d5dd..3ca8475a 100644 --- a/provider/app.go +++ b/provider/app.go @@ -150,7 +150,8 @@ func appResource() *schema.Resource { }, "url": { Type: schema.TypeString, - Description: "A URL to be proxied to from inside the workspace. This hsould be of the form http://localhost:PORT[/SUBPATH]" + + Description: "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.", ForceNew: true, Optional: true, From c1bc7aeaceaa7e6d119b8c5f3e118bfc063c7660 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 19 Jul 2023 11:59:18 +0000 Subject: [PATCH 3/5] 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 7b70bf6a..ffc6c0cd 100644 --- a/docs/resources/app.md +++ b/docs/resources/app.md @@ -76,7 +76,7 @@ resource "coder_app" "intellij" { - `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. - `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). - `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. -- `url` (String) A URL to be proxied to from inside the workspace. Either "command" or "url" may be specified, but not both. +- `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. ### Read-Only From bc7e76ff968a2974641f8894fff80eb4d753ab9d Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Wed, 19 Jul 2023 15:00:19 +0300 Subject: [PATCH 4/5] Update app.go --- provider/app.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/provider/app.go b/provider/app.go index 3ca8475a..d8471788 100644 --- a/provider/app.go +++ b/provider/app.go @@ -150,8 +150,8 @@ func appResource() *schema.Resource { }, "url": { Type: schema.TypeString, - Description: "A URL to be proxied to from inside the workspace." + - "This should be of the form \"http://localhost:PORT[/SUBPATH]\"." + + Description: "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.", ForceNew: true, Optional: true, From 4682f02442edf46d55f8302feff745eecd23ec01 Mon Sep 17 00:00:00 2001 From: Atif Ali Date: Wed, 19 Jul 2023 12:02:38 +0000 Subject: [PATCH 5/5] 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 ffc6c0cd..53a8c127 100644 --- a/docs/resources/app.md +++ b/docs/resources/app.md @@ -76,7 +76,7 @@ resource "coder_app" "intellij" { - `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. - `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). - `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. -- `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. +- `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. ### Read-Only