Add list of supported values for flags that represent an enum field (#…

…1036) ## Changes This PR adds the list of supported values for flags that represent an enum field in the flag's documentation.
databricks · Dec 6, 2023 · a6752a5 · a6752a5
1 parent e9ed828
commit a6752a5
Show file tree

Hide file tree

Showing 23 changed files with 123 additions and 45 deletions.
diff --git a/.codegen/service.go.tmpl b/.codegen/service.go.tmpl
@@ -26,6 +26,13 @@ import (
 	{{skipThisFile}}
 {{end}}
 
+{{define "printArray" -}}
+{{if le (len .) 5 -}}
+	[{{range $index, $element := .}}{{if ne $index 0}}, {{end}}{{$element.Name}}{{end}}]
+{{- else -}}[{{range $index, $element := .}}
+  {{$element.Name}},{{end}}
+]{{end}}{{end}}
+
 {{define "service"}}
 // Slice with functions to override default command behavior.
 // Functions can be added from the `init()` function in manually curated files in this directory.
@@ -106,7 +113,7 @@ func new{{.PascalName}}() *cobra.Command {
 			{{else if .Entity.ArrayValue }}// TODO: array: {{.Name}}
 			{{else if .Entity.MapValue }}// TODO: map via StringToStringVar: {{.Name}}
 			{{else if .Entity.IsEmpty }}// TODO: output-only field
-			{{else if .Entity.Enum }}cmd.Flags().Var(&{{$method.CamelName}}Req.{{.PascalName}}, "{{.KebabName}}", `{{.Summary | without "`"}}`)
+			{{else if .Entity.Enum }}cmd.Flags().Var(&{{$method.CamelName}}Req.{{.PascalName}}, "{{.KebabName}}", `{{.Summary | without "`" | trimSuffix "."}}. Supported values: {{template "printArray" .Entity.Enum}}`)
 			{{else}}cmd.Flags().{{template "arg-type" .Entity}}(&{{$method.CamelName}}Req.{{.PascalName}}, "{{.KebabName}}", {{$method.CamelName}}Req.{{.PascalName}}, `{{.Summary | without "`"}}`)
 			{{end}}
 		{{- end -}}

diff --git a/cmd/account/groups/groups.go b/cmd/account/groups/groups.go
diff --git a/cmd/account/log-delivery/log-delivery.go b/cmd/account/log-delivery/log-delivery.go
diff --git a/cmd/account/private-access/private-access.go b/cmd/account/private-access/private-access.go
diff --git a/cmd/account/service-principals/service-principals.go b/cmd/account/service-principals/service-principals.go
diff --git a/cmd/account/users/users.go b/cmd/account/users/users.go
diff --git a/cmd/account/workspaces/workspaces.go b/cmd/account/workspaces/workspaces.go
diff --git a/cmd/workspace/catalogs/catalogs.go b/cmd/workspace/catalogs/catalogs.go
diff --git a/cmd/workspace/cluster-policies/cluster-policies.go b/cmd/workspace/cluster-policies/cluster-policies.go
diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go
diff --git a/cmd/workspace/dashboards/dashboards.go b/cmd/workspace/dashboards/dashboards.go
diff --git a/cmd/workspace/experiments/experiments.go b/cmd/workspace/experiments/experiments.go
diff --git a/cmd/workspace/groups/groups.go b/cmd/workspace/groups/groups.go