Help us shape the future of Go! Take the 2026 Go Developer Survey

api

package
v2.17.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2026 License: BSD-3-Clause Imports: 72 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterWebhookTrigger

func RegisterWebhookTrigger(g *echo.Group, webhookService *webhook.WebhookService, appCtx handlerutil.ActivityAppContext)

RegisterWebhookTrigger registers the public (unauthenticated) trigger endpoint. The token in the URL is the sole authentication mechanism. Rate-limited via PerTokenRateLimitForPaths in router_bootstrap.go: authentic tokens get per-token buckets, everything else shares a per-source-IP budget.

func SetupAPI

func SetupAPI(e *echo.Echo, apiGroup *echo.Group, appCtx handlerutil.ActivityAppContext, cfg *config.Config, deps HandlerDeps) huma.API

SetupAPI creates and configures the Huma API attached to the Echo 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 HandlerDeps added in v2.6.0

type HandlerDeps struct {
	fx.In

	AppImages         *appimages.ApplicationImagesService
	User              *user.Module
	Project           *project.Module
	Environment       *environment.Module
	Settings          *settings.Module
	JobSchedule       *job.Module
	Search            *search.Module
	Container         *container.Module
	Image             *image.Module
	Build             *build.BuildService
	Volume            *volume.Module
	S3Destination     *s3.Module
	Network           *network.NetworkService
	Port              *port.PortService
	Swarm             *swarm.Module
	Podman            *podman.Module
	ImageUpdate       *imageupdate.Module
	Auth              *auth.Module
	Passkey           *passkey.PasskeyService
	Oidc              *oidc.OidcService
	Docker            *docker.DockerClientService
	Template          *template.Module
	ContainerRegistry *registry.Module
	System            *system.Module
	Diagnostics       *diagnostics.DiagnosticsService
	Updater           *updater.Module
	Event             *event.Module
	Activity          *activity.Module
	Version           *version.VersionService
	Notification      *notification.Module
	ApiKey            *apikey.Module
	Apns              *apns.Module
	Federated         *federated.FederatedCredentialService
	GitRepository     *gitrepo.Module
	GitOpsSync        *gitops.Module
	Webhook           *webhook.Module
	Vulnerability     *vulnerability.Module
	Dashboard         *dashboard.Module
	Role              *role.Module
	Variable          *variable.Module
	Upload            *upload.Module
	Health            *health.Module
}

HandlerDeps contains the services required to register HTTP API handlers. It contains only dependencies consumed by SetupAPI and the authentication middleware.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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