Unexport certain API types and functions (#2366)

Author: sgalsaleh

api/api.go

@@ -31,7 +31,7 @@ import (
 
 // @externalDocs.description	OpenAPI
 // @externalDocs.url			https://swagger.io/resources/open-api/
-type API struct {
+type api struct {
 	cfg types.APIConfig
 
 	logger          logrus.FieldLogger
@@ -41,43 +41,43 @@ type API struct {
 	consoleController      console.Controller
 	linuxInstallController linuxinstall.Controller
 
-	handlers Handlers
+	handlers handlers
 }
 
-type APIOption func(*API)
+type apiOption func(*api)
 
-func WithAuthController(authController auth.Controller) APIOption {
-	return func(a *API) {
+func WithAuthController(authController auth.Controller) apiOption {
+	return func(a *api) {
 		a.authController = authController
 	}
 }
 
-func WithConsoleController(consoleController console.Controller) APIOption {
-	return func(a *API) {
+func WithConsoleController(consoleController console.Controller) apiOption {
+	return func(a *api) {
 		a.consoleController = consoleController
 	}
 }
 
-func WithLinuxInstallController(linuxInstallController linuxinstall.Controller) APIOption {
-	return func(a *API) {
+func WithLinuxInstallController(linuxInstallController linuxinstall.Controller) apiOption {
+	return func(a *api) {
 		a.linuxInstallController = linuxInstallController
 	}
 }
 
-func WithLogger(logger logrus.FieldLogger) APIOption {
-	return func(a *API) {
+func WithLogger(logger logrus.FieldLogger) apiOption {
+	return func(a *api) {
 		a.logger = logger
 	}
 }
 
-func WithMetricsReporter(metricsReporter metrics.ReporterInterface) APIOption {
-	return func(a *API) {
+func WithMetricsReporter(metricsReporter metrics.ReporterInterface) apiOption {
+	return func(a *api) {
 		a.metricsReporter = metricsReporter
 	}
 }
 
-func New(cfg types.APIConfig, opts ...APIOption) (*API, error) {
-	api := &API{
+func New(cfg types.APIConfig, opts ...apiOption) (*api, error) {
+	api := &api{
 		cfg: cfg,
 	}
 
@@ -97,7 +97,7 @@ func New(cfg types.APIConfig, opts ...APIOption) (*API, error) {
 		api.logger = l
 	}
 
-	if err := api.InitHandlers(api.cfg); err != nil {
+	if err := api.initHandlers(); err != nil {
 		return nil, fmt.Errorf("init handlers: %w", err)
 	}
 

api/handlers.go

@@ -7,20 +7,19 @@ import (
 	consolehandler "github.com/replicatedhq/embedded-cluster/api/internal/handlers/console"
 	healthhandler "github.com/replicatedhq/embedded-cluster/api/internal/handlers/health"
 	linuxhandler "github.com/replicatedhq/embedded-cluster/api/internal/handlers/linux"
-	"github.com/replicatedhq/embedded-cluster/api/types"
 )
 
-type Handlers struct {
+type handlers struct {
 	auth    *authhandler.Handler
 	console *consolehandler.Handler
 	health  *healthhandler.Handler
 	linux   *linuxhandler.Handler
 }
 
-func (a *API) InitHandlers(cfg types.APIConfig) error {
+func (a *api) initHandlers() error {
 	// Auth handler
 	authHandler, err := authhandler.New(
-		cfg.Password,
+		a.cfg.Password,
 		authhandler.WithLogger(a.logger),
 		authhandler.WithAuthController(a.authController),
 	)
@@ -50,7 +49,7 @@ func (a *API) InitHandlers(cfg types.APIConfig) error {
 
 	// Linux handler
 	linuxHandler, err := linuxhandler.New(
-		cfg,
+		a.cfg,
 		linuxhandler.WithLogger(a.logger),
 		linuxhandler.WithMetricsReporter(a.metricsReporter),
 		linuxhandler.WithInstallController(a.linuxInstallController),

api/routes.go

@@ -8,7 +8,7 @@ import (
 	httpSwagger "github.com/swaggo/http-swagger/v2"
 )
 
-func (a *API) RegisterRoutes(router *mux.Router) {
+func (a *api) RegisterRoutes(router *mux.Router) {
 	router.HandleFunc("/health", a.handlers.health.GetHealth).Methods("GET")
 
 	// Hack to fix issue
@@ -30,7 +30,7 @@ func (a *API) RegisterRoutes(router *mux.Router) {
 	a.registerConsoleRoutes(authenticatedRouter)
 }
 
-func (a *API) registerLinuxRoutes(router *mux.Router) {
+func (a *api) registerLinuxRoutes(router *mux.Router) {
 	linuxRouter := router.PathPrefix("/linux").Subrouter()
 
 	installRouter := linuxRouter.PathPrefix("/install").Subrouter()
@@ -50,11 +50,11 @@ func (a *API) registerLinuxRoutes(router *mux.Router) {
 	installRouter.HandleFunc("/status", a.handlers.linux.PostSetStatus).Methods("POST")
 }
 
-func (a *API) registerKubernetesRoutes(router *mux.Router) {
+func (a *api) registerKubernetesRoutes(router *mux.Router) {
 	// kubernetesRouter := router.PathPrefix("/kubernetes").Subrouter()
 }
 
-func (a *API) registerConsoleRoutes(router *mux.Router) {
+func (a *api) registerConsoleRoutes(router *mux.Router) {
 	consoleRouter := router.PathPrefix("/console").Subrouter()
 	consoleRouter.HandleFunc("/available-network-interfaces", a.handlers.console.GetListAvailableNetworkInterfaces).Methods("GET")
 }