chore(api): export and document for more clear interface (#2375)

* chore(api): export types for more clear interface

* docs

Author: emosbaugh

api/api.go

@@ -13,6 +13,8 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// API represents the main HTTP API server for the Embedded Cluster application.
+//
 //	@title			Embedded Cluster API
 //	@version		0.1
 //	@description	This is the API for the Embedded Cluster project.
@@ -31,7 +33,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
@@ -44,40 +46,47 @@ type api struct {
 	handlers handlers
 }
 
-type apiOption func(*api)
+// Option is a function that configures the API.
+type Option func(*API)
 
-func WithAuthController(authController auth.Controller) apiOption {
-	return func(a *api) {
+// WithAuthController configures the auth controller for the API.
+func WithAuthController(authController auth.Controller) Option {
+	return func(a *API) {
 		a.authController = authController
 	}
 }
 
-func WithConsoleController(consoleController console.Controller) apiOption {
-	return func(a *api) {
+// WithConsoleController configures the console controller for the API.
+func WithConsoleController(consoleController console.Controller) Option {
+	return func(a *API) {
 		a.consoleController = consoleController
 	}
 }
 
-func WithLinuxInstallController(linuxInstallController linuxinstall.Controller) apiOption {
-	return func(a *api) {
+// WithLinuxInstallController configures the linux install controller for the API.
+func WithLinuxInstallController(linuxInstallController linuxinstall.Controller) Option {
+	return func(a *API) {
 		a.linuxInstallController = linuxInstallController
 	}
 }
 
-func WithLogger(logger logrus.FieldLogger) apiOption {
-	return func(a *api) {
+// WithLogger configures the logger for the API. If not provided, a default logger will be created.
+func WithLogger(logger logrus.FieldLogger) Option {
+	return func(a *API) {
 		a.logger = logger
 	}
 }
 
-func WithMetricsReporter(metricsReporter metrics.ReporterInterface) apiOption {
-	return func(a *api) {
+// WithMetricsReporter configures the metrics reporter for the API.
+func WithMetricsReporter(metricsReporter metrics.ReporterInterface) Option {
+	return func(a *API) {
 		a.metricsReporter = metricsReporter
 	}
 }
 
-func New(cfg types.APIConfig, opts ...apiOption) (*api, error) {
-	api := &api{
+// New creates a new API instance.
+func New(cfg types.APIConfig, opts ...Option) (*API, error) {
+	api := &API{
 		cfg: cfg,
 	}
 

api/controllers/linux/install/hostpreflight.go

@@ -43,12 +43,12 @@ func (c *InstallController) RunHostPreflights(ctx context.Context, opts RunHostP
 		IsUI:                  opts.IsUI,
 	})
 	if err != nil {
-		return fmt.Errorf("failed to prepare host preflights: %w", err)
+		return fmt.Errorf("prepare host preflights: %w", err)
 	}
 
 	err = c.stateMachine.Transition(lock, StatePreflightsRunning)
 	if err != nil {
-		return fmt.Errorf("failed to transition states: %w", err)
+		return fmt.Errorf("transition states: %w", err)
 	}
 
 	go func() (finalErr error) {
@@ -78,7 +78,7 @@ func (c *InstallController) RunHostPreflights(ctx context.Context, opts RunHostP
 			HostPreflightSpec: hpf,
 		})
 		if err != nil {
-			return fmt.Errorf("failed to run host preflights: %w", err)
+			return fmt.Errorf("run host preflights: %w", err)
 		}
 
 		return nil

api/handlers.go

@@ -16,7 +16,7 @@ type handlers struct {
 	linux   *linuxhandler.Handler
 }
 
-func (a *api) initHandlers() error {
+func (a *API) initHandlers() error {
 	// Auth handler
 	authHandler, err := authhandler.New(
 		a.cfg.Password,

api/routes.go

@@ -8,7 +8,9 @@ import (
 	httpSwagger "github.com/swaggo/http-swagger/v2"
 )
 
-func (a *api) RegisterRoutes(router *mux.Router) {
+// RegisterRoutes registers the routes for the API. A router is passed in to allow for the routes
+// to be registered on a subrouter.
+func (a *API) RegisterRoutes(router *mux.Router) {
 	router.HandleFunc("/health", a.handlers.health.GetHealth).Methods("GET")
 
 	// Hack to fix issue
@@ -30,7 +32,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 +52,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")
 }