advice_kit_api

type AdviceDefinition struct {
	// AssessmentQueryApplicable A Target Query that identifies targets that could have this advice.
	AssessmentQueryApplicable string `json:"assessmentQueryApplicable"`

	// AssessmentQueryExclude A Target Query that identifies targets that should be excluded by this advice.
	AssessmentQueryExclude *string `json:"assessmentQueryExclude,omitempty"`

	// Category An optional category for the advice, e.g. 'Reliability', 'Scalability', 'Redundancy'.
	Category *string `json:"category,omitempty"`

	// Icon An svg of an icon that represents the advice, e.g. `data:image/svg+xml,%3Csvg....svg%3E%0A`.
	Icon string `json:"icon"`

	// Id A technical ID that is used to uniquely identify this type of advice. You will typically want to use something like `org.example.extension.my-fancy-advice`.
	Id string `json:"id"`

	// Label A human-readable label for the advice.
	Label string `json:"label"`

	// Status Provides details about advice.
	Status AdviceDefinitionStatus `json:"status"`

	// Tags A list of tags that describe the advice.
	Tags *[]string `json:"tags,omitempty"`

	// Version The version of the advice. This is used to identify the version of the advice and is used for compatibility checks.
	Version string `json:"version"`
}

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

type AdviceDefinitionStatus struct {
	// ActionNeeded Provides details about an advice lifecycle status actions needed.
	ActionNeeded AdviceDefinitionStatusActionNeeded `json:"actionNeeded"`

	// Implemented Provides details about advice lifecycle status implemented.
	Implemented AdviceDefinitionStatusImplemented `json:"implemented"`

	// ValidationNeeded Provides details about advice lifecycle status validation needed.
	ValidationNeeded AdviceDefinitionStatusValidationNeeded `json:"validationNeeded"`
}

type AdviceDefinitionStatusActionNeeded struct {
	// AssessmentQuery A Assessment Target Query Addon that is used to identify targets with this advice in the target list of the assessmentQueryApplicable
	AssessmentQuery string `json:"assessmentQuery"`

	// Description Provides details description about advice lifecycle status actions needed.
	Description AdviceDefinitionStatusActionNeededDescription `json:"description"`
}

type AdviceDefinitionStatusActionNeededDescription struct {
	// Instruction A human-readable instructions of the action needed in mark down format. (you can use placeholder like ${target.attr('k8s.pod.name')})
	Instruction string `json:"instruction"`

	// Motivation A human-readable motivation of the action needed in mark down format. (you can use placeholder like ${target.attr('k8s.pod.name')})
	Motivation string `json:"motivation"`

	// Summary A human-readable summary of the action needed in mark down format. (you can use placeholder like ${target.attr('k8s.pod.name')})
	Summary string `json:"summary"`
}

type AdviceDefinitionStatusImplemented struct {
	// Description Provides details description about a advice lifecycle status implemented.
	Description AdviceDefinitionStatusImplementedDescription `json:"description"`
}

type AdviceDefinitionStatusImplementedDescription struct {
	// Summary A human-readable summary of the implemented in mark down format. (you can use placeholder like ${target.attr('k8s.pod.name')})
	Summary string `json:"summary"`
}

type AdviceDefinitionStatusValidationNeeded struct {
	// Description Provides details description about advice lifecycle status validation needed.
	Description AdviceDefinitionStatusValidationNeededDescription `json:"description"`

	// Validation A list of validations that are available for this advice.
	Validation *[]Validation `json:"validation,omitempty"`
}

type AdviceDefinitionStatusValidationNeededDescription struct {
	// Summary A human-readable summary of the validation needed in mark down format. (you can use placeholder like ${target.attr('k8s.pod.name')})
	Summary string `json:"summary"`
}

type AdviceKitError struct {
	// Detail A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty"`

	// Instance A URI reference that identifies the specific occurrence of the problem.
	Instance *string `json:"instance,omitempty"`

	// Title A short, human-readable summary of the problem type.
	Title string `json:"title"`

	// Type A URI reference that identifies the problem type.
	Type *string `json:"type,omitempty"`
}

type AdviceList struct {
	Advice []DescribingEndpointReference `json:"advice"`
}

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

type DescribingEndpointReference struct {
	// Method HTTP method to use when calling the HTTP endpoint.
	Method DescribingEndpointReferenceMethod `json:"method"`

	// Path Absolute path of the HTTP endpoint.
	Path string `json:"path"`
}

type DescribingEndpointReferenceMethod string

type Experiment = interface{}

type ExperimentTemplate = interface{}

type Validation struct {
	// Description A human-readable description for the validation or for the experiment template. Markdown supported.
	Description *string `json:"description,omitempty"`

	// Experiment Provides an experiment definition to automate the validation.
	// It may contain advice placeholders, which will be substituted with target properties, but otherwise contains only fixed values.
	// An experiment definition can be exported as JSON from the UI.
	Experiment *Experiment `json:"experiment,omitempty"`

	// ExperimentTemplate Provides an experiment template definition to automate the validation.
	// It may contain advice placeholders, which will be substituted with target properties, and supports experiment template variables, which can be set dynamically during the experiment creation process through the UI.
	// An experiment template definition can be exported as JSON from the UI.
	// An experiment template definition has precedence over an experiment definition. For compatibility reasons both can be given.
	ExperimentTemplate *ExperimentTemplate `json:"experimentTemplate,omitempty"`

	// ForEachAttribute The attribute that is used to multiply the validation.
	ForEachAttribute *string `json:"forEachAttribute,omitempty"`

	// Id A technical ID that is used to uniquely identify this validation. You will typically want to use something like `org.example.extension.my-fancy-advice-validation.1`.
	Id string `json:"id"`

	// Name A human-readable name for the validation.
	Name string `json:"name"`

	// ShortDescription A human-readable short description for the validation or for the experiment template. Text Only.
	ShortDescription string `json:"shortDescription"`

	// Type The type of the validation. Distinguishes between a textual description of a manual validation and a dynamic validation by an experiment.
	Type ValidationType `json:"type"`
}

type ValidationType string