huma

package

v1.17.4 Latest Latest Go to latest Published: Apr 13, 2026 License: BSD-3-Clause Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getarcaneapp/arcane

Links

Open Source Insights

Documentation ¶

Index ¶

func SetupAPI(router *gin.Engine, apiGroup *gin.RouterGroup, cfg *config.Config, ...) huma.API
func SetupAPIForSpec() huma.API
type Services

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SetupAPI ¶

func SetupAPI(router *gin.Engine, apiGroup *gin.RouterGroup, cfg *config.Config, svc *Services) huma.API

SetupAPI creates and configures the Huma API alongside the existing Gin router.

func SetupAPIForSpec ¶

func SetupAPIForSpec() huma.API

SetupAPIForSpec creates a Huma API instance for OpenAPI spec generation only. No services are required - this is purely for schema generation.

Types ¶

type Services ¶

type Services struct {
	User              *services.UserService
	Auth              *services.AuthService
	Oidc              *services.OidcService
	ApiKey            *services.ApiKeyService
	AppImages         *services.ApplicationImagesService
	Font              *services.FontService
	Project           *services.ProjectService
	Event             *services.EventService
	Version           *services.VersionService
	Environment       *services.EnvironmentService
	Settings          *services.SettingsService
	JobSchedule       *services.JobService
	SettingsSearch    *services.SettingsSearchService
	ContainerRegistry *services.ContainerRegistryService
	Template          *services.TemplateService
	Docker            *services.DockerClientService
	Image             *services.ImageService
	ImageUpdate       *services.ImageUpdateService
	Build             *services.BuildService
	BuildWorkspace    *services.BuildWorkspaceService
	Volume            *services.VolumeService
	Container         *services.ContainerService
	Network           *services.NetworkService
	Port              *services.PortService
	Swarm             *services.SwarmService
	Notification      *services.NotificationService
	Apprise           *services.AppriseService //nolint:staticcheck // Apprise still functional, deprecated in favor of Shoutrrr
	Updater           *services.UpdaterService
	CustomizeSearch   *services.CustomizeSearchService
	System            *services.SystemService
	SystemUpgrade     *services.SystemUpgradeService
	GitRepository     *services.GitRepositoryService
	GitOpsSync        *services.GitOpsSyncService
	Webhook           *services.WebhookService
	Vulnerability     *services.VulnerabilityService
	Dashboard         *services.DashboardService
	Config            *config.Config
}

Services holds all service dependencies needed by Huma handlers.

Source Files ¶

View all Source files

huma.go

Directories ¶

Path	Synopsis
handlers
middleware

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL