v1beta1

type APITokenSource struct {
	// SecretKeyRef selects an API token by looking up the value in a secret.
	//
	// +optional
	SecretKeyRef *SecretKeySelector `json:"secretKeyRef,omitempty"`
}

type APITriggerEventSink struct {
	URL string `json:"url"`

	// Token is the API token to use.
	//
	// +optional
	Token string `json:"token,omitempty"`

	// TokenFrom allows the API token to be provided by another resource.
	//
	// +optional
	TokenFrom *APITokenSource `json:"tokenFrom,omitempty"`
}

type APIWorkflowExecutionSink struct {
	URL string `json:"url"`

	// Token is the API token to use.
	//
	// +optional
	Token string `json:"token,omitempty"`

	// TokenFrom allows the API token to be provided by another resource.
	//
	// +optional
	TokenFrom *APITokenSource `json:"tokenFrom,omitempty"`
}

type Condition struct {
	Status             corev1.ConditionStatus `json:"status"`
	LastTransitionTime metav1.Time            `json:"lastTransitionTime"`

	// Reason identifies the cause of the given status using an API-locked
	// camel-case identifier.
	//
	// +optional
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable description of the given status.
	//
	// +optional
	Message string `json:"message,omitempty"`
}

type Container struct {
	// Image is the Docker image to run when this webhook receives an event.
	Image string `json:"image"`

	// Input is the input script to provide to the container.
	//
	// +optional
	Input []string `json:"input,omitempty"`

	// Command is the path to the executable to run when the container starts.
	//
	// +optional
	Command string `json:"command,omitempty"`

	// Args are the command arguments.
	//
	// +optional
	Args []string `json:"args,omitempty"`

	// Spec is the Relay specification to be provided to the container image.
	//
	// +optional
	Spec UnstructuredObject `json:"spec,omitempty"`

	// Env allows environment variables to be provided to the container image.
	//
	// +optional
	Env UnstructuredObject `json:"env,omitempty"`
}

type Decorator struct {
	// Name is a way to identify the decorator
	Name string `json:"name"`

	// Link is a link-type decorator.
	// +optional
	Link *DecoratorLink `json:"link,omitempty"`
}

type DecoratorLink struct {
	// Description describes what the URI points to.
	Description string `json:"description"`

	// URI must follow the syntax outlined in
	// https://datatracker.ietf.org/doc/html/rfc3986 and must be parsable by
	// Go's url.Parse function.
	URI string `json:"uri"`
}

type Log struct {
	// Name of the associated log.
	//
	// +optional
	Name string `json:"name"`

	// Context of the associated log.
	//
	// +optional
	Context string `json:"context"`
}

type LogStepMessageSource struct{}

type NamespaceTemplate struct {
	// Metadata is the metadata to associate with the namespace to create, such
	// as a name and list of labels. If not specified, values are automatically
	// generated.
	//
	// Labels from the tenant are automatically propagated onto the created
	// namespace.
	//
	// +optional
	// +kubebuilder:validation:XPreserveUnknownFields
	Metadata metav1.ObjectMeta `json:"metadata,omitempty"`
}

type Parameter struct {
	// Name is a unique name for this parameter.
	Name string `json:"name"`

	// Value is the default value for this parameter. If not specified, a value
	// must be provided at runtime.
	//
	// +optional
	Value *Unstructured `json:"default,omitempty"`
}

type Run struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              RunSpec `json:"spec"`

	// +optional
	Status RunStatus `json:"status,omitempty"`
}

type RunCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Cancelled;Completed;Succeeded
	Type RunConditionType `json:"type"`
}

type RunConditionType string

type RunList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Run `json:"items"`
}

type RunSpec struct {
	// Parameters assigns values to parameters defined in the workflow.
	//
	// +optional
	Parameters UnstructuredObject `json:"parameters,omitempty"`

	// State allows applying desired state changes.
	//
	// +optional
	State RunState `json:"state,omitempty"`

	// WorkflowRef selects a defined workflow to use for this run.
	WorkflowRef corev1.LocalObjectReference `json:"workflowRef"`
}

type RunState struct {
	// Workflow allows applying desired workflow state changes.
	//
	// +optional
	Workflow UnstructuredObject `json:"workflow,omitempty"`

	// Step allows applying desired step state changes.
	// +optional
	Steps map[string]UnstructuredObject `json:"steps,omitempty"`
}

type RunStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Steps provides information about the status of each step that makes up
	// this workflow run.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Steps []*StepStatus `json:"steps,omitempty"`

	// StartTime is the this run began executing.
	//
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CompletionTime is the time this run ended, whether successful or not.
	//
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Conditions are the possible observable conditions for this run.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []RunCondition `json:"conditions,omitempty"`
}

type SecretKeySelector struct {
	corev1.LocalObjectReference `json:",inline"`

	// Key is the key from the secret to use.
	Key string `json:"key"`
}

type SpecValidationStepMessageSource struct {
	// Path is the location within the spec to the expression that originated
	// the message, expressed as a JSON Pointer (RFC 6901).
	//
	// If not specified, or empty, the path refers to the entire spec.
	Path string `json:"path"`

	// Expression is the actual data of the expression that failed to validate,
	// copied verbatim from the workflow definition and relative to the path
	// field, if it is available.
	//
	// +optional
	Expression *Unstructured `json:"expression,omitempty"`

	// Schema is the JSON Schema that caused the validation error relative to
	// the path field.
	//
	// +optional
	Schema *Unstructured `json:"schema,omitempty"`
}

type Step struct {
	// Name is a unique name for this step.
	Name string `json:"name"`

	// Container defines the properties of the Docker container to run.
	Container `json:",inline"`

	// When provides a set of conditions that must be met for this step to run.
	//
	// +optional
	When *Unstructured `json:"when,omitempty"`

	// DependsOn causes this step to run after the given step names.
	//
	// +optional
	DependsOn []string `json:"dependsOn,omitempty"`
}

type StepCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=Completed;Skipped;Succeeded
	Type StepConditionType `json:"type"`
}

type StepConditionType string

type StepMessage struct {
	// Source is the origin of the message.
	Source StepMessageSource `json:"source"`

	// Severity indicates the importance of this message.
	//
	// +kubebuilder:validation:Enum=Trace;Informational;Warning;Error
	Severity StepMessageSeverity `json:"severity"`

	// ObservationTime is the time that the causal event for the message
	// occurred.
	//
	// This may be different from the time the message was actually added to the
	// Run object.
	ObservationTime metav1.Time `json:"observationTime"`

	// Short is an abbreviated description of the message (if available) that
	// could be shown as a title or in space-constrained user interfaces.
	//
	// If not specified, the first few characters of the details will be used
	// instead.
	//
	// +kubebuilder:validation:MaxLength=24
	// +optional
	Short string `json:"short,omitempty"`

	// Details is the text content of the message to show to an interested user.
	//
	// +kubebuilder:validation:MaxLength=1024
	Details string `json:"details"`
}

type StepMessageSeverity string

type StepMessageSource struct {
	// WhenEvaluation is a source used by runtime processing of when conditions.
	//
	// +optional
	WhenEvaluation *WhenEvaluationStepMessageSource `json:"whenEvaluation,omitempty"`

	// SpecValidation is a source used by the runtime validation of the spec.
	//
	// +optional
	SpecValidation *SpecValidationStepMessageSource `json:"specValidation,omitempty"`

	// Log is a source used by the logging APIs exposed to step authors.
	//
	// +optional
	Log *LogStepMessageSource `json:"log,omitempty"`
}

type StepOutput struct {
	// Name is the name of this output.
	Name string `json:"name"`

	// Sensitive is whether this output contains sensitive or privileged data.
	// If this output is sensitive, the value will not be set.
	//
	// +optional
	Sensitive bool `json:"sensitive"`

	// Value is the value provided by the step for the output.
	//
	// +optional
	Value *Unstructured `json:"value"`
}

type StepStatus struct {
	// Name is the name of this step.
	Name string `json:"name"`

	// Outputs are each of the outputs provided by this step, if available.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Outputs []*StepOutput `json:"outputs,omitempty"`

	// +optional
	// +listType=map
	// +listMapKey=name
	Decorators []*Decorator `json:"decorators,omitempty"`

	// Messages provide additional human-oriented context information about a
	// step's execution.
	//
	// +optional
	Messages []*StepMessage `json:"messages,omitempty"`

	// StartTime is the time this step began executing.
	//
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CompletionTime is the time this step ended, whether successful or not.
	//
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// InitializationTime is the time taken to initialize the step.
	//
	// +optional
	InitializationTime *metav1.Time `json:"initTime,omitempty"`

	// Associated logs for this step.
	//
	// +optional
	Logs []*Log `json:"logs,omitempty"`

	// Conditions are the possible observable conditions for this step.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []StepCondition `json:"conditions,omitempty"`
}

type Tenant struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              TenantSpec `json:"spec"`

	// +optional
	Status TenantStatus `json:"status"`
}

type TenantCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=NamespaceReady;EventSinkReady;ToolInjectionReady;Ready
	Type TenantConditionType `json:"type"`
}

type TenantConditionType string

type TenantList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Tenant `json:"items"`
}

type TenantSpec struct {
	// NamespaceTemplate defines a template for a namespace that will be created
	// for this scope. If not specified, resources are created in the namespace
	// of this resource.
	//
	// +optional
	NamespaceTemplate NamespaceTemplate `json:"namespaceTemplate,omitempty"`

	// ToolInjection allows configuration of the PVC to be used for the
	// container runtime tools.
	//
	// +optional
	ToolInjection ToolInjection `json:"toolInjection,omitempty"`

	// TriggerEventSink represents the destination for events received as part
	// of trigger processing. If not specified, events will be logged and
	// discarded.
	//
	// +optional
	TriggerEventSink TriggerEventSink `json:"triggerEventSink,omitempty"`

	// WorkflowExecutionSink represents the destrination for workflow run requests.
	// If not specified, the metadata-api workflow run endpoint will reject a
	// request to run a workflow.
	//
	// +optional
	WorkflowExecutionSink WorkflowExecutionSink `json:"workflowExecutionSink,omitempty"`
}

type TenantStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Namespace is the namespace managed by this tenant or the namespace of the
	// tenant if it is unmanaged.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// Conditions are the observations of this resource's state.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []TenantCondition `json:"conditions,omitempty"`
}

type ToolInjection struct {
	// VolumeClaimTemplate is an optional definition of the PVC that will be
	// populated and attached to every tenant container.
	//
	// +optional
	VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
}

type TriggerEventSink struct {
	// API is an event sink for the propretiary Relay API.
	//
	// +optional
	API *APITriggerEventSink `json:"api,omitempty"`
}

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

type UnstructuredObject map[string]Unstructured

type WebhookTrigger struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              WebhookTriggerSpec `json:"spec"`

	// +optional
	Status WebhookTriggerStatus `json:"status,omitempty"`
}

type WebhookTriggerCondition struct {
	Condition `json:",inline"`

	// Type is the identifier for this condition.
	//
	// +kubebuilder:validation:Enum=ServiceReady;Ready
	Type WebhookTriggerConditionType `json:"type"`
}

type WebhookTriggerConditionType string

type WebhookTriggerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []WebhookTrigger `json:"items"`
}

type WebhookTriggerSpec struct {
	// TenantRef selects the tenant to apply this trigger to.
	TenantRef corev1.LocalObjectReference `json:"tenantRef"`

	// Name is a friendly name for this webhook trigger used for authentication
	// and reporting.
	//
	// +optional
	Name string `json:"name,omitempty"`

	// Container defines the properties of the Docker container to run.
	Container `json:",inline"`
}

type WebhookTriggerStatus struct {
	// ObservedGeneration is the generation of the resource specification that
	// this status matches.
	//
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Namespace is the Kubernetes namespace containing the target resources of
	// this webhook trigger.
	//
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// URL is the endpoint for the webhook once provisioned.
	//
	// +optional
	URL string `json:"url,omitempty"`

	// Conditions are the observations of this resource's tate.
	//
	// +optional
	// +listType=map
	// +listMapKey=type
	Conditions []WebhookTriggerCondition `json:"conditions,omitempty"`
}

type WhenEvaluationStepMessageSource struct {
	// Path is the location within the when condition to the expression that
	// originated the message, expressed as a JSON Pointer (RFC 6901).
	//
	// If not specified, or empty, the path refers to the entire when condition.
	Path string `json:"path"`

	// Expression is the actual data of the expression that failed to evaluate,
	// copied verbatim from the workflow definition and relative to the path
	// field, if it is available.
	//
	// +optional
	Expression *Unstructured `json:"expression,omitempty"`
}

type Workflow struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              WorkflowSpec `json:"spec"`
}

type WorkflowExecutionSink struct {
	// API is a workflow run sink for the propretiary Relay API.
	//
	// +optional
	API *APIWorkflowExecutionSink `json:"api,omitempty"`
}

type WorkflowList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Workflow `json:"items"`
}

type WorkflowSpec struct {
	// TenantRef selects the tenant to use for this workflow.
	TenantRef corev1.LocalObjectReference `json:"tenantRef"`

	// Parameters are the definitions of parameters used by this workflow.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Parameters []*Parameter `json:"parameters,omitempty"`

	// Steps are the individual steps that make up the workflow.
	//
	// +optional
	// +listType=map
	// +listMapKey=name
	Steps []*Step `json:"steps,omitempty"`
}