v1

Documentation

Overview

Package v1 contains the V1 API for ToolHive.

Index

• func ClientRouter(manager client.Manager, workloadManager workloads.Manager, ...) http.Handler
• func DiscoveryRouter() http.Handler
• func GroupsRouter(groupManager groups.Manager, workloadManager workloads.Manager, ...) http.Handler
• func HealthcheckRouter(containerRuntime rt.Runtime) http.Handler
• func RegistryRouter() http.Handler
• func SecretsRouter() http.Handler
• func VersionRouter() http.Handler
• func WorkloadRouter(workloadManager workloads.Manager, containerRuntime runtime.Runtime, ...) http.Handler
• type ClientRoutes
• type DiscoveryRoutes
• type GroupsRoutes
• type RegistryRoutes
  • func NewRegistryRoutes() *RegistryRoutes
  • func NewRegistryRoutesWithProvider(provider config.Provider) *RegistryRoutes
• type RegistryType
• type SecretsRoutes
  • func NewSecretsRoutes() *SecretsRoutes
  • func NewSecretsRoutesWithProvider(provider config.Provider) *SecretsRoutes
• type UpdateRegistryRequest
• type UpdateRegistryResponse
• type WorkloadRoutes
• type WorkloadService
  • func NewWorkloadService(workloadManager workloads.Manager, groupManager groups.Manager, ...) *WorkloadService
  • func (s *WorkloadService) BuildFullRunConfig(ctx context.Context, req *createRequest) (*runner.RunConfig, error)
  • func (s *WorkloadService) CreateWorkloadFromRequest(ctx context.Context, req *createRequest) (*runner.RunConfig, error)
  • func (s *WorkloadService) GetWorkloadNamesFromRequest(ctx context.Context, req bulkOperationRequest) ([]string, error)
  • func (s *WorkloadService) UpdateWorkloadFromRequest(ctx context.Context, name string, req *createRequest) (*runner.RunConfig, error)

Functions

func ClientRouter

func ClientRouter(
	manager client.Manager,
	workloadManager workloads.Manager,
	groupManager groups.Manager,
) http.Handler

ClientRouter creates a new router for the client API.

func DiscoveryRouter

func DiscoveryRouter() http.Handler

DiscoveryRouter creates a new router for the client discovery API.

func GroupsRouter

func GroupsRouter(groupManager groups.Manager, workloadManager workloads.Manager, clientManager client.Manager) http.Handler

GroupsRouter creates a new GroupsRoutes instance.

func HealthcheckRouter

func HealthcheckRouter(containerRuntime rt.Runtime) http.Handler

HealthcheckRouter sets up healthcheck route.

func RegistryRouter

func RegistryRouter() http.Handler

RegistryRouter creates a new router for the registry API.

func SecretsRouter

func SecretsRouter() http.Handler

SecretsRouter creates a new router for the secrets API.

func VersionRouter

func VersionRouter() http.Handler

VersionRouter sets up the version route.

func WorkloadRouter

func WorkloadRouter(
	workloadManager workloads.Manager,
	containerRuntime runtime.Runtime,
	groupManager groups.Manager,
	debugMode bool,
) http.Handler

WorkloadRouter creates a new WorkloadRoutes instance.

Types

type ClientRoutes

type ClientRoutes struct {
	// contains filtered or unexported fields
}

ClientRoutes defines the routes for the client API.

type DiscoveryRoutes

type DiscoveryRoutes struct{}

DiscoveryRoutes defines the routes for the client discovery API.

type GroupsRoutes

type GroupsRoutes struct {
	// contains filtered or unexported fields
}

GroupsRoutes defines the routes for group management.

type RegistryRoutes

type RegistryRoutes struct {
	// contains filtered or unexported fields
}

RegistryRoutes defines the routes for the registry API.

func NewRegistryRoutes

func NewRegistryRoutes() *RegistryRoutes

NewRegistryRoutes creates a new RegistryRoutes with the default config provider

func NewRegistryRoutesWithProvider

func NewRegistryRoutesWithProvider(provider config.Provider) *RegistryRoutes

NewRegistryRoutesWithProvider creates a new RegistryRoutes with a custom config provider This is useful for testing

type RegistryType

type RegistryType string

RegistryType represents the type of registry

const (
	// RegistryTypeFile represents a local file registry
	RegistryTypeFile RegistryType = "file"
	// RegistryTypeURL represents a remote URL registry
	RegistryTypeURL RegistryType = "url"
	// RegistryTypeDefault represents a built-in registry
	RegistryTypeDefault RegistryType = "default"
)

type SecretsRoutes

type SecretsRoutes struct {
	// contains filtered or unexported fields
}

SecretsRoutes defines the routes for the secrets API.

func NewSecretsRoutes

func NewSecretsRoutes() *SecretsRoutes

NewSecretsRoutes creates a new SecretsRoutes with the default config provider

func NewSecretsRoutesWithProvider

func NewSecretsRoutesWithProvider(provider config.Provider) *SecretsRoutes

NewSecretsRoutesWithProvider creates a new SecretsRoutes with a custom config provider

type UpdateRegistryRequest

type UpdateRegistryRequest struct {
	// Registry URL (for remote registries)
	URL *string `json:"url,omitempty"`
	// Local registry file path
	LocalPath *string `json:"local_path,omitempty"`
	// Allow private IP addresses for registry URL
	AllowPrivateIP *bool `json:"allow_private_ip,omitempty"`
}

UpdateRegistryRequest represents the request for updating a registry

@Description	Request containing registry configuration updates

type UpdateRegistryResponse

type UpdateRegistryResponse struct {
	// Status message
	Message string `json:"message"`
	// Registry type after update
	Type string `json:"type"`
}

UpdateRegistryResponse represents the response for updating a registry

@Description	Response containing update result

type WorkloadRoutes

type WorkloadRoutes struct {
	// contains filtered or unexported fields
}

WorkloadRoutes defines the routes for workload management.

type WorkloadService

type WorkloadService struct {
	// contains filtered or unexported fields
}

WorkloadService handles business logic for workload operations

func NewWorkloadService

func NewWorkloadService(
	workloadManager workloads.Manager,
	groupManager groups.Manager,
	containerRuntime runtime.Runtime,
	debugMode bool,
) *WorkloadService

NewWorkloadService creates a new WorkloadService instance

func (*WorkloadService) BuildFullRunConfig

func (s *WorkloadService) BuildFullRunConfig(ctx context.Context, req *createRequest) (*runner.RunConfig, error)

BuildFullRunConfig builds a complete RunConfig

func (*WorkloadService) CreateWorkloadFromRequest

func (s *WorkloadService) CreateWorkloadFromRequest(ctx context.Context, req *createRequest) (*runner.RunConfig, error)

CreateWorkloadFromRequest creates a workload from a request

func (*WorkloadService) GetWorkloadNamesFromRequest

func (s *WorkloadService) GetWorkloadNamesFromRequest(ctx context.Context, req bulkOperationRequest) ([]string, error)

GetWorkloadNamesFromRequest gets workload names from either the names field or group

func (*WorkloadService) UpdateWorkloadFromRequest

func (s *WorkloadService) UpdateWorkloadFromRequest(ctx context.Context, name string, req *createRequest) (*runner.RunConfig, error)

UpdateWorkloadFromRequest updates a workload from a request