common

type Display ¶

type Display struct {
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

type Duration ¶

type Duration time.Duration

Duration wraps time.Duration. It is used to parse the custom duration format from YAML. This type should not propagate beyond the scope of input/output processing. +kubebuilder:validation:Type=string +kubebuilder:validation:Format=duration +kubebuilder:validation:Pattern=`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`

func ParseDuration(s string) (Duration, error)

func (d Duration) MarshalJSON() ([]byte, error)

func (d *Duration) MarshalText() ([]byte, error)

func (d Duration) MarshalYAML() (any, error)

func (d *Duration) Set(s string) error

func (d Duration) String() string

func (d *Duration) Type() string

func (d *Duration) UnmarshalJSON(bytes []byte) error

func (d *Duration) UnmarshalText(text []byte) error

func (d *Duration) UnmarshalYAML(unmarshal func(any) error) error

type DurationString ¶

type DurationString string

DurationString is a string that represents a duration, such as "1h", "30m", "15s", etc. It is used to unmarshal a duration string from JSON or YAML, and validate that it is a valid duration string.

Not converting the duration string into a time.Duration type allows us to avoid the issue of changing the initial input with an alias. This is something that happens when we use Duration type, because when the duration is unmarshalled then marshaled again, the input can be changed with an equivalent duration. For example "14d" will be changed to "2w".

So, use DurationString instead of Duration when you want to preserve the original input string. If, for any reason, you need to convert the DurationString to a time.Duration, you can use the ParseDuration function.

+kubebuilder:validation:Type=string +kubebuilder:validation:Format=duration +kubebuilder:validation:Pattern=`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`

func (d *DurationString) UnmarshalJSON(bytes []byte) error

func (d *DurationString) UnmarshalYAML(unmarshal func(any) error) error

type JSONRef ¶

type JSONRef struct {
	// Ref is the JSON reference.
	// That's the only thing used during the marshalling / unmarshalling process.
	// Other attributes are ignored during these processes.
	Ref string `json:"$ref" yaml:"$ref"`
	// Path is a list of string that will be used to find from the root of the struct the object pointed.
	Path []string `json:"-" yaml:"-"`
	// Object will contain the pointer to the actual object referenced by Ref
	Object any `json:"-" yaml:"-"`
}

func (j *JSONRef) UnmarshalJSON(data []byte) error

func (j *JSONRef) UnmarshalYAML(unmarshal func(any) error) error

type Plugin ¶

type Plugin struct {
	// Kind is the type of the plugin (e.g., Panel, Variable, Datasource, etc.).
	Kind string `json:"kind" yaml:"kind"`
	// Metadata is an optional field that contains additional information such as version and registry of the plugin.
	Metadata *PluginMetadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Schemaless
	Spec any `json:"spec" yaml:"spec"`
}

func (p Plugin) JSONMarshal() ([]byte, error)

func (p *Plugin) UnmarshalJSON(data []byte) error

func (p *Plugin) UnmarshalYAML(unmarshal func(any) error) error

type PluginMetadata ¶

type PluginMetadata struct {
	// Version is optional. If not provided, it means the latest version available in the Perses instance.
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
	// Registry is optional. If not provided, it means the default registry: "perses.dev".
	Registry string `json:"registry,omitempty" yaml:"registry,omitempty"`
}