v1alpha1

type APIKey struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   APIKeySpec   `json:"spec,omitempty"`
	Status APIKeyStatus `json:"status,omitempty"`
}

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

type APIKeySpec struct {
	// ExpirationSeconds is the requested duration of validity of the API key.
	// +optional
	ExpirationSeconds *int64 `json:"expirationSeconds"`
}

type APIKeyStatus struct {
	// Key is the opaque API key.
	// +optional
	Key string `json:"token"`

	// ExpirationTimestamp is the time of expiration of the returned API key.
	// +optional
	ExpirationTimestamp metav1.Time `json:"expirationTimestamp"`
}

type ChallengeDescription struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ChallengeDescriptionSpec   `json:"spec,omitempty"`
	Status ChallengeDescriptionStatus `json:"status,omitempty"`
}

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

type ChallengeDescriptionSpec struct {
	// Title is the name of the challenge
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Title string `json:"title"`

	// Description is the content of the challenge
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Description string `json:"description"`

	// Category is the category this challenge belongs to.
	// +kubebuilder:validation:Optional
	Category string `json:"category"`

	// Value is the number of points which are added upon solving the challenge.
	// +kubebuilder:default=0
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Minimum=0
	Value int `json:"value"`

	// Hints provides a list of hints to help solve the challenge.
	// +kubebuilder:validation:Optional
	Hints []ChallengeHint `json:"hints"`

	// Manifests provide the Kubernetes manifests which should be created when a new instance of the challenge is
	// requested. The manifests are placed in a dedicated namespace. The namespace provided in those manifests is
	// overwritten.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinItems=1
	Manifests []runtime.RawExtension `json:"manifests"`
}

type ChallengeDescriptionStatus struct{}

type ChallengeHint struct {
	// Description is the content of the hint.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Description string `json:"description"`

	// Cost is the number of points which are to be deducted from the overall score if this hint is being used.
	// +kubebuilder:default=0
	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Minimum=0
	Cost int `json:"cost"`
}

type ChallengeInstance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ChallengeInstanceSpec   `json:"spec,omitempty"`
	Status ChallengeInstanceStatus `json:"status,omitempty"`
}

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

type ChallengeInstanceSpec struct {
	// ExpirationSeconds is the requested duration of validity of the Challenge instance.
	// +optional
	ExpirationSeconds *int64 `json:"expirationSeconds"`

	// ChallengeDescriptionName is the name of the ChallengeDescription this challenge instance is related to.
	// +kubebuilder:validation:Required
	ChallengeDescriptionName string `json:"challengeDescriptionName"`
}

type ChallengeInstanceStatus struct {
	// ExpirationTimestamp is the time of expiration of the challenge instance.
	// +optional
	ExpirationTimestamp metav1.Time `json:"expirationTimestamp"`
}