gen:

go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest

go run ./scripts/docsgen/...

build: terraform-provider-coder

-`access_url` (String) The access URL of the Coder deployment provisioning this workspace.

-`id` (String) UUID of the workspace.

-`name` (String) Name of the workspace.

-`owner` (String, Deprecated) Username of the workspace owner.

-`owner_email` (String, Deprecated) Email address of the workspace owner.

-`owner_groups` (List of String, Deprecated) List of groups the workspace owner belongs to.

-`owner_id` (String, Deprecated) UUID of the workspace owner.

-`owner_name` (String, Deprecated) Name of the workspace owner.

-`owner_oidc_access_token` (String, Deprecated) A valid OpenID Connect access token of the workspace owner. This is only available if the workspace owner authenticated with OpenID Connect. If a valid token cannot be obtained, this value will be an empty string.

-`owner_session_token` (String, Deprecated) Session token for authenticating with a Coder deployment. It is regenerated everytime a workspace is started.

-`owner` (String, Deprecated: Use`coder_workspace_owner.name` instead.) Username of the workspace owner.

-`owner_email` (String, Deprecated: Use`coder_workspace_owner.email` instead.) Email address of the workspace owner.

-`owner_groups` (List of String, Deprecated: Use`coder_workspace_owner.groups` instead.) List of groups the workspace owner belongs to.

-`owner_id` (String, Deprecated: Use`coder_workspace_owner.id` instead.) UUID of the workspace owner.

-`owner_name` (String, Deprecated: Use`coder_workspace_owner.full_name` instead.) Name of the workspace owner.

-`owner_oidc_access_token` (String, Deprecated: Use`coder_workspace_owner.oidc_access_token` instead.) A valid OpenID Connect access token of the workspace owner. This is only available if the workspace owner authenticated with OpenID Connect. If a valid token cannot be obtained, this value will be an empty string.

-`owner_session_token` (String, Deprecated: Use`coder_workspace_owner.session_token` instead.) Session token for authenticating with a Coder deployment. It is regenerated everytime a workspace is started.

-`start_count` (Number) A computed count based on "transition" state. If "start", count will equal 1.

-`template_id` (String) ID of the workspace's template.

-`template_name` (String) Name of the workspace's template.

-`feature_use_managed_variables` (Boolean, Deprecated) Feature: use managed Terraform variables. The feature flag is not used anymore as Terraform variables are now exclusively utilized for template-wide variables.

-`feature_use_managed_variables` (Boolean, Deprecated: Terraform variables are now exclusively utilized for template-wide variables after the removal of support for legacy parameters.) Feature: use managed Terraform variables. The feature flag is not used anymore as Terraform variables are now exclusively utilized for template-wide variables.

-`url` (String) The URL to access Coder.

-`dir` (String) The starting directory when a user creates a shell session. Defaults to $HOME.

-`display_apps` (Block Set, Max: 1) The list of built-in apps to display in the agent bar. (see[below for nested schema](#nestedblock--display_apps))

-`env` (Map of String) A mapping of environment variables to set inside the workspace.

-`login_before_ready` (Boolean, Deprecated) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the startup_script is done and has exited. When enabled, users may see an incomplete workspace when logging in.

-`login_before_ready` (Boolean, Deprecated: Configure startup_script_behavior instead. This attribute will be removed in a future version of the provider.) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the startup_script is done and has exited. When enabled, users may see an incomplete workspace when logging in.

-`metadata` (Block List) Each "metadata" block defines a single item consisting of a key/value pair. This feature is in alpha and may break in future releases. (see[below for nested schema](#nestedblock--metadata))

-`motd_file` (String) The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be /etc/motd.

-`order` (Number) The order determines the position of agents in the UI presentation. The lowest order is shown first and agents with equal order are sorted by name (ascending order).

-`shutdown_script` (String) A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a "coder_script" resource with "run_on_stop" set to true.

-`shutdown_script_timeout` (Number, Deprecated) Time in seconds until the agent lifecycle status is marked as timed out during shutdown, this happens when the shutdown script has not completed (exited) in the given time.

-`shutdown_script_timeout` (Number, Deprecated: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during shutdown, this happens when the shutdown script has not completed (exited) in the given time.

-`startup_script` (String) A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready. This option is an alias for defining a "coder_script" resource with "run_on_start" set to true.

-`startup_script_behavior` (String) This option sets the behavior of the "startup_script". When set to "blocking", the startup_script must exit before the workspace is ready. When set to "non-blocking", the startup_script may run in the background and the workspace will be ready immediately. Default is "non-blocking", although "blocking" is recommended. This option is an alias for defining a "coder_script" resource with "start_blocks_login" set to true (blocking).

-`startup_script_timeout` (Number, Deprecated) Time in seconds until the agent lifecycle status is marked as timed out during start, this happens when the startup script has not completed (exited) in the given time.

-`startup_script_timeout` (Number, Deprecated: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during start, this happens when the startup script has not completed (exited) in the given time.

-`troubleshooting_url` (String) A URL to a document with instructions for troubleshooting problems with the agent.

-`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))

-`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) A display name to identify the app.

-`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).

-`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.

-`relative_path` (Boolean, Deprecated:`relative_path` on apps is deprecated, use`subdomain` instead.) 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) An external url if "external=true" or 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.

package main

import (

)

varreDeprecatedProperty=regexp.MustCompile("`([^`]+)`\\(([^,\\)]+), Deprecated\\) ([^\n]+)")

funcmain() {

p:=provider.New()

err:=exposeDeprecationMessage(p)

iferr!=nil {

log.Fatal(err)

}

}

funcexposeDeprecationMessage(p*schema.Provider)error {

fordataSourceName,dataSource:=rangep.DataSourcesMap {

docFile:=filepath.Join(docsDir,"data-sources",strings.Replace(dataSourceName,"coder_","",1)+".md")

err:=adjustDocFile(docFile,dataSource.Schema)

iferr!=nil {

returnxerrors.Errorf("unable to adjust data-source doc file (data-source: %s): %w",dataSourceName,err)

}

}

forresourceName,resource:=rangep.ResourcesMap {

docFile:=filepath.Join(docsDir,"resources",strings.Replace(resourceName,"coder_","",1)+".md")

err:=adjustDocFile(docFile,resource.Schema)

iferr!=nil {

returnxerrors.Errorf("unable to adjust resource doc file (resource: %s): %w",resourceName,err)

}

}

docFile:=filepath.Join(docsDir,"index.md")

err:=adjustDocFile(docFile,p.Schema)

iferr!=nil {

returnxerrors.Errorf("unable to adjust index doc file: %w",err)

}

}

funcadjustDocFile(docPathstring,schemasmap[string]*schema.Schema)error {

doc,err:=os.ReadFile(docPath)

iferr!=nil {

returnxerrors.Errorf("can't read the source doc file: %w",err)

}

result:=writeDeprecationMessage(doc,schemas)

err=os.WriteFile(docPath,result,0644)

iferr!=nil {

returnxerrors.Errorf("can't write modified doc file: %w",err)

}

}

funcwriteDeprecationMessage(doc []byte,schemasmap[string]*schema.Schema) []byte {

returnreDeprecatedProperty.ReplaceAllFunc(doc,func(m []byte) []byte {

matches:=reDeprecatedProperty.FindSubmatch(m)

propertyName:=matches[1]

description:=matches[3]

sch:=schemas[string(propertyName)]

ifstring(description)!=sch.Description {

log.Printf("warn: same property name `%s` but description does not match, most likely a different property",propertyName)

}

returnbytes.Replace(m, []byte("Deprecated"), []byte(fmt.Sprintf("Deprecated: %s",sch.Deprecated)),1)

})

}