apiv1

package
v0.5.4 Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var V1_PREFIX string

Functions

func Registerv1Routes

func Registerv1Routes(api huma.API)

Types

type ConfigOutput

type ConfigOutput struct {
	Body struct {
		Config config.Config `json:"config"`
	}
}

func GetConfig

func GetConfig(ctx context.Context, input *struct{}) (*ConfigOutput, error)

GetConfig returns the current running configuration

type HealthzOutput

type HealthzOutput struct {
	Body struct {
		Status string `json:"status"`
	}
}

func GetHealthz

func GetHealthz(ctx context.Context, input *struct{}) (*HealthzOutput, error)

GetHealthz returns current app liveness state

type NotifStateInput

type NotifStateInput struct {
	Body struct {
		Enabled bool `json:"enabled" enum:"true,false" doc:"Set state of notifications" required:"true"`
	}
}

type NotifStateOutput

type NotifStateOutput struct {
	Body struct {
		Enabled bool `json:"enabled" enum:"true,false" doc:"Frigate-Notify enabled for notifications" default:"true"`
	}
}

func GetNotifState

func GetNotifState(ctx context.Context, input *struct{}) (*NotifStateOutput, error)

GetNotifState returns whether app is enabled for sending notifications or not

func PostNotifState

func PostNotifState(ctx context.Context, input *NotifStateInput) (*NotifStateOutput, error)

PostNotifState updates state to enable or disable app notifications

type NotifTestOutput

type NotifTestOutput struct {
	Body struct {
		Message string `json:"message"`
	}
}

func PostNotifTest

func PostNotifTest(ctx context.Context, input *struct{}) (*NotifTestOutput, error)

PostNotifTest collects most the recent event from Frigate & sends a test notification to configured providers

type PutConfigInput

type PutConfigInput struct {
	Body struct {
		Config       config.Config `json:"config"`
		SkipSave     bool          `json:"skipsave,omitempty" doc:"Skip writing new config to file" default:"false"`
		SkipBackup   bool          `json:"skipbackup,omitempty" doc:"Skip creating config file backup" default:"false"`
		SkipValidate bool          `json:"skipvalidate,omitempty" doc:"Skip config validation checking"`
		SkipReload   bool          `json:"skipreload,omitempty" doc:"Skip config reload after updating settings" hidden:"true"`
	}
}

type PutConfigOutput

type PutConfigOutput struct {
	Body struct {
		Status string   `json:"status"`
		Errors []string `json:"errors,omitempty"`
	}
}

func PutConfig

func PutConfig(ctx context.Context, input *PutConfigInput) (*PutConfigOutput, error)

PutConfig replaces the current running configuration

type ReadyzOutput

type ReadyzOutput struct {
	Body struct {
		Status string `json:"status"`
	}
}

func GetReadyz

func GetReadyz(ctx context.Context, input *struct{}) (*ReadyzOutput, error)

GetReadyz returns current app ready state

type ReloadOutput

type ReloadOutput struct {
	Body struct {
		Message string `json:"message"`
	}
}

func PostReload

func PostReload(ctx context.Context, input *struct{}) (*ReloadOutput, error)

PostReload reloads current app config

type StatusOutput

type StatusOutput struct {
	Body struct {
		Status models.Status `json:"status"`
	}
}

func GetStatus

func GetStatus(ctx context.Context, input *struct{}) (*StatusOutput, error)

GetStatus returns current app component statuses

type VersionOutput

type VersionOutput struct {
	Body struct {
		Version string `json:"version" example:"v0.0.0" doc:"Current version of Frigate-Notify"`
	}
}

func GetVersion

func GetVersion(ctx context.Context, input *struct{}) (*VersionOutput, error)

GetVersion returns the current running app version

Jump to

Keyboard shortcuts

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