v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions v1alpha1 API group +kubebuilder:object:generate=true +groupName=swaggergen.krateo.io +versionName=v1alpha1

Index

• Constants
• Variables
• type Definition
  • func (in *Definition) DeepCopy() *Definition
  • func (in *Definition) DeepCopyInto(out *Definition)
  • func (in *Definition) DeepCopyObject() runtime.Object
  • func (mg *Definition) GetCondition(ct rtv1.ConditionType) rtv1.Condition
  • func (mg *Definition) GetDeletionPolicy() rtv1.DeletionPolicy
  • func (mg *Definition) SetConditions(c ...rtv1.Condition)
  • func (mg *Definition) SetDeletionPolicy(r rtv1.DeletionPolicy)
• type DefinitionList
  • func (in *DefinitionList) DeepCopy() *DefinitionList
  • func (in *DefinitionList) DeepCopyInto(out *DefinitionList)
  • func (in *DefinitionList) DeepCopyObject() runtime.Object
  • func (l *DefinitionList) GetItems() []resource.Managed
• type DefinitionSpec
  • func (in *DefinitionSpec) DeepCopy() *DefinitionSpec
  • func (in *DefinitionSpec) DeepCopyInto(out *DefinitionSpec)
• type DefinitionStatus
  • func (in *DefinitionStatus) DeepCopy() *DefinitionStatus
  • func (in *DefinitionStatus) DeepCopyInto(out *DefinitionStatus)
• type Resource
  • func (in *Resource) DeepCopy() *Resource
  • func (in *Resource) DeepCopyInto(out *Resource)
• type VerbsDescription
  • func (in *VerbsDescription) DeepCopy() *VerbsDescription
  • func (in *VerbsDescription) DeepCopyInto(out *VerbsDescription)

Constants

const (
	Group   = "swaggergen.krateo.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

var (
	DefinitionKind             = reflect.TypeOf(Definition{}).Name()
	DefinitionGroupKind        = schema.GroupKind{Group: Group, Kind: DefinitionKind}.String()
	DefinitionKindAPIVersion   = DefinitionKind + "." + SchemeGroupVersion.String()
	DefinitionGroupVersionKind = SchemeGroupVersion.WithKind(DefinitionKind)
)

Types

type Definition

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

	Spec   DefinitionSpec   `json:"spec,omitempty"`
	Status DefinitionStatus `json:"status,omitempty"`
}

Definition is a definition type with a spec and a status.

func (*Definition) DeepCopy

func (in *Definition) DeepCopy() *Definition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Definition.

func (*Definition) DeepCopyInto

func (in *Definition) DeepCopyInto(out *Definition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Definition) DeepCopyObject

func (in *Definition) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Definition) GetCondition

func (mg *Definition) GetCondition(ct rtv1.ConditionType) rtv1.Condition

GetCondition of this Definition.

func (*Definition) GetDeletionPolicy

func (mg *Definition) GetDeletionPolicy() rtv1.DeletionPolicy

GetDeletionPolicy of this Definition.

func (*Definition) SetConditions

func (mg *Definition) SetConditions(c ...rtv1.Condition)

SetConditions of this Definition.

func (*Definition) SetDeletionPolicy

func (mg *Definition) SetDeletionPolicy(r rtv1.DeletionPolicy)

SetDeletionPolicy of this Definition.

type DefinitionList

type DefinitionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Definition `json:"items"`
}

+kubebuilder:object:root=true DefinitionList is a list of Definition objects.

func (*DefinitionList) DeepCopy

func (in *DefinitionList) DeepCopy() *DefinitionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DefinitionList.

func (*DefinitionList) DeepCopyInto

func (in *DefinitionList) DeepCopyInto(out *DefinitionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DefinitionList) DeepCopyObject

func (in *DefinitionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*DefinitionList) GetItems

func (l *DefinitionList) GetItems() []resource.Managed

GetItems of this DefinitionList.

type DefinitionSpec

type DefinitionSpec struct {
	rtv1.ManagedSpec `json:",inline"`
	// Represent the path to the swagger file
	SwaggerPath string `json:"swaggerPath"`
	// Group: the group of the resource to manage
	// +immutable
	ResourceGroup string `json:"resourceGroup"`
	// The resource to manage
	// +optional
	Resource Resource `json:"resource"`
}

DefinitionSpec is the specification of a Definition.

func (*DefinitionSpec) DeepCopy

func (in *DefinitionSpec) DeepCopy() *DefinitionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DefinitionSpec.

func (*DefinitionSpec) DeepCopyInto

func (in *DefinitionSpec) DeepCopyInto(out *DefinitionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DefinitionStatus

type DefinitionStatus struct {
	rtv1.ManagedStatus `json:",inline"`

	Created bool `json:"created"`
}

DefinitionStatus is the status of a Definition.

func (*DefinitionStatus) DeepCopy

func (in *DefinitionStatus) DeepCopy() *DefinitionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DefinitionStatus.

func (*DefinitionStatus) DeepCopyInto

func (in *DefinitionStatus) DeepCopyInto(out *DefinitionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource

type Resource struct {
	// Name: the name of the resource to manage
	// +immutable
	Kind string `json:"kind"`
	// VerbsDescription: the list of verbs to use on this resource
	// +optional
	VerbsDescription []VerbsDescription `json:"verbsDescription"`
	// Identifier
	// +optional
	Identifier string `json:"identifier,omitempty"`
}

func (*Resource) DeepCopy

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VerbsDescription

type VerbsDescription struct {
	// Name of the action to perform when this api is called [create, update, list, get, delete]
	// +kubebuilder:validation:Enum=create;update;list;get;delete;
	// +immutable
	// +required
	Action string `json:"action"`
	// Method: the http method to use [GET, POST, PUT, DELETE, PATCH]
	// +kubebuilder:validation:Enum=GET;POST;PUT;DELETE;PATCH
	// +immutable
	// +required
	Method string `json:"method"`
	// Path: the path to the api - has to be the same path as the one in the swagger file you are referencing
	// +immutable
	// +required
	Path string `json:"path"`
	// AltFieldMapping: the alternative mapping of the fields to use in the request
	// +optional
	AltFieldMapping map[string]string `json:"altFieldMapping,omitempty"`
}

func (*VerbsDescription) DeepCopy

func (in *VerbsDescription) DeepCopy() *VerbsDescription

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VerbsDescription.

func (*VerbsDescription) DeepCopyInto

func (in *VerbsDescription) DeepCopyInto(out *VerbsDescription)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.