Fix: Swagger.Enable

mtojek · mtojek · commit ebf2e9ec1bd6 · 2022-12-15T17:06:24.000+01:00
diff --git a/cli/deployment/config.go b/cli/deployment/config.go
@@ -431,7 +431,7 @@ func newConfig() *codersdk.DeploymentConfig {
 			Default: 24 * 30 * time.Hour,
 		},
 		Swagger: &codersdk.SwaggerConfig{
-			Enabled: &codersdk.DeploymentConfigField[bool]{
+			Enable: &codersdk.DeploymentConfigField[bool]{
 				Name:    "Enable swagger endpoint",
 				Usage:   "Expose the swagger endpoint via /swagger.",
 				Flag:    "swagger-enabled",
diff --git a/cli/server.go b/cli/server.go
@@ -610,8 +610,8 @@ func Server(vip *viper.Viper, newAPI func(context.Context, *coderd.Options) (*co
 				), cfg.Prometheus.Address.Value, "prometheus")()
 			}
 
-			if cfg.Swagger.Enabled.Value {
-				options.SwaggerEndpointEnabled = cfg.Swagger.Enabled.Value
+			if cfg.Swagger.Enable.Value {
+				options.SwaggerEndpointEnable = cfg.Swagger.Enable.Value
 			}
 
 			// We use a separate coderAPICloser so the Enterprise API
diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden
@@ -169,7 +169,7 @@ Flags:
                                                      Consumes $CODER_SSH_KEYGEN_ALGORITHM
                                                      (default "ed25519")
       --swagger-enabled                              Expose the swagger endpoint via /swagger.
-                                                     Consumes $CODER_SWAGGER_ENABLED
+                                                     Consumes $CODER_SWAGGER_ENABLE
       --telemetry                                    Whether telemetry is enabled or not.
                                                      Coder collects anonymized usage data to
                                                      help improve our product.
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -112,7 +112,7 @@ type Options struct {
 	DeploymentConfig            *codersdk.DeploymentConfig
 	UpdateCheckOptions          *updatecheck.Options // Set non-nil to enable update checking.
 
-	SwaggerEndpointEnabled bool
+	SwaggerEndpointEnable bool
 
 	HTTPClient *http.Client
 }
@@ -601,7 +601,7 @@ func New(options *Options) *API {
 		})
 	})
 
-	if options.SwaggerEndpointEnabled {
+	if options.SwaggerEndpointEnable {
 		// Swagger UI requires the URL trailing slash. Otherwise, the browser tries to load /assets
 		// from http://localhost:8080/assets instead of http://localhost:8080/swagger/assets.
 		r.Get("/swagger", http.RedirectHandler("/swagger/", http.StatusSeeOther).ServeHTTP)
diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -290,7 +290,7 @@ func NewOptions(t *testing.T, options *Options) (func(http.Handler), context.Can
 			AgentStatsRefreshInterval:   options.AgentStatsRefreshInterval,
 			DeploymentConfig:            options.DeploymentConfig,
 			UpdateCheckOptions:          options.UpdateCheckOptions,
-			SwaggerEndpointEnabled:      options.SwaggerEndpointEnabled,
+			SwaggerEndpointEnable:       options.SwaggerEndpointEnabled,
 		}
 }
 
diff --git a/codersdk/deploymentconfig.go b/codersdk/deploymentconfig.go
@@ -143,7 +143,7 @@ type ProvisionerConfig struct {
 }
 
 type SwaggerConfig struct {
-	Enabled *DeploymentConfigField[bool] `json:"enabled" typescript:",notnull"`
+	Enable *DeploymentConfigField[bool] `json:"enable" typescript:",notnull"`
 }
 
 type Flaggable interface {
diff --git a/scripts/develop.sh b/scripts/develop.sh
@@ -121,7 +121,7 @@ fatal() {
 	trap 'fatal "Script encountered an error"' ERR
 
 	cdroot
-	start_cmd API "" "${CODER_DEV_SHIM}" server --address 0.0.0.0:3000 --swagger-enabled
+	start_cmd API "" "${CODER_DEV_SHIM}" server --address 0.0.0.0:3000 --swagger-enable
 
 	echo '== Waiting for Coder to become ready'
 	# Start the timeout in the background so interrupting this script
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -618,7 +618,7 @@ export interface ServiceBanner {
 
 // From codersdk/deploymentconfig.go
 export interface SwaggerConfig {
-  readonly enabled: DeploymentConfigField<boolean>
+  readonly enable: DeploymentConfigField<boolean>
 }
 
 // From codersdk/deploymentconfig.go

Original file line number	Diff line number	Diff line change
`@@ -610,8 +610,8 @@ func Server(vip viper.Viper, newAPI func(context.Context, coderd.Options) (*co`
`610`	`610`	`), cfg.Prometheus.Address.Value, "prometheus")()`
`611`	`611`	`}`
`612`	`612`
`613`		`- if cfg.Swagger.Enabled.Value {`
`614`		`- options.SwaggerEndpointEnabled = cfg.Swagger.Enabled.Value`
	`613`	`+ if cfg.Swagger.Enable.Value {`
	`614`	`+ options.SwaggerEndpointEnable = cfg.Swagger.Enable.Value`
`615`	`615`	`}`
`616`	`616`
`617`	`617`	`// We use a separate coderAPICloser so the Enterprise API`
Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ func NewOptions(t testing.T, options Options) (func(http.Handler), context.Can`
`290`	`290`	`AgentStatsRefreshInterval: options.AgentStatsRefreshInterval,`
`291`	`291`	`DeploymentConfig: options.DeploymentConfig,`
`292`	`292`	`UpdateCheckOptions: options.UpdateCheckOptions,`
`293`		`- SwaggerEndpointEnabled: options.SwaggerEndpointEnabled,`
	`293`	`+ SwaggerEndpointEnable: options.SwaggerEndpointEnabled,`
`294`	`294`	`}`
`295`	`295`	`}`
`296`	`296`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ type ProvisionerConfig struct {`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`type SwaggerConfig struct {`
`146`		- Enabled *DeploymentConfigField[bool] `json:"enabled" typescript:",notnull"`
	`146`	+ Enable *DeploymentConfigField[bool] `json:"enable" typescript:",notnull"`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`type Flaggable interface {`
Original file line number	Diff line number	Diff line change
`@@ -618,7 +618,7 @@ export interface ServiceBanner {`
`618`	`618`
`619`	`619`	`// From codersdk/deploymentconfig.go`
`620`	`620`	`export interface SwaggerConfig {`
`621`		`- readonly enabled: DeploymentConfigField<boolean>`
	`621`	`+ readonly enable: DeploymentConfigField<boolean>`
`622`	`622`	`}`
`623`	`623`
`624`	`624`	`// From codersdk/deploymentconfig.go`