doc comments

coder · aslilac · Aug 31, 2023 · Aug 31, 2023 · Aug 31, 2023 · Aug 31, 2023
commit 0ffbee5c503d552f79ac005f5ff40eb9563f2f05
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -124,13 +124,16 @@ type CreateTemplateRequest struct {
 }
 
 // CreateWorkspaceRequest provides options for creating a new workspace.
+// Either TemplateID or TemplateVersionID must be specified. They cannot both be present.
 type CreateWorkspaceRequest struct {
-	TemplateID        uuid.UUID `json:"template_id,omitempty" validate:"required_without=TemplateVersionID,excluded_with=TemplateVersionID" format:"uuid"`
+	// TemplateID specifies which template should be used for creating the workspace.
+	TemplateID uuid.UUID `json:"template_id,omitempty" validate:"required_without=TemplateVersionID,excluded_with=TemplateVersionID" format:"uuid"`
+	// TemplateVersionID can be used to specify a specific version of a template for creating the workspace.
 	TemplateVersionID uuid.UUID `json:"template_version_id,omitempty" validate:"required_without=TemplateID,excluded_with=TemplateID" format:"uuid"`
 	Name              string    `json:"name" validate:"workspace_name,required"`
 	AutostartSchedule *string   `json:"autostart_schedule"`
 	TTLMillis         *int64    `json:"ttl_ms,omitempty"`
-	// ParameterValues allows for additional parameters to be provided
+	// RichParameterValues allows for additional parameters to be provided
 	// during the initial provision.
 	RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"`
 }

diff --git a/docs/api/schemas.md b/docs/api/schemas.md