preflight_kit_api

type AbstractExperimentExecutionStepAO struct {
	// CustomLabel Custom label assigned during experiment design to express the intention of this step
	CustomLabel *string `json:"customLabel,omitempty"`

	// Ended Timestamp when this experiment step ended
	Ended *time.Time `json:"ended,omitempty"`

	// Id Unique identifier of this step execution
	Id *openapi_types.UUID `json:"id,omitempty"`

	// IgnoreFailure Whether the experiment should fail/error immediately in case this step fails/errors.
	IgnoreFailure *bool `json:"ignoreFailure,omitempty"`

	// Parameters Step-specific parameters of the experiment step configuration
	Parameters *map[string]interface{} `json:"parameters,omitempty"`

	// PredecessorId Unique identifier of the step execution that precedes this step, null if it is the first step of a lane
	PredecessorId *openapi_types.UUID `json:"predecessorId,omitempty"`

	// Reason Reason in case this experiment step execution failed or errored
	Reason *string `json:"reason,omitempty"`

	// Started Timestamp when this experiment step was started
	Started *time.Time `json:"started,omitempty"`

	// State Current state of this step in the experiment (e.g. RUNNING, FAILED, ERRORED, COMPLETED)
	State *string `json:"state,omitempty"`

	// StepType Type of this step execution (e.g. ACTION, WAIT)
	StepType string `json:"stepType"`
	// contains filtered or unexported fields
}

type AttributeAO struct {
	// Key The key of the attribute, may be associated multiple times to the same target
	Key string `json:"key"`

	// Value The value of the attribute
	Value string `json:"value"`
}

type BlastRadiusAO struct {
	// Maximum In case a fixed number of as subset of specified targets should be effected
	Maximum *int32 `json:"maximum,omitempty"`

	// Percentage In case a percentage subset of the specified targets should be effected
	Percentage *int32 `json:"percentage,omitempty"`

	// Predicate Query defining the overall superset of targets being effected
	Predicate *TargetPredicate `json:"predicate,omitempty"`

	// TargetType Target type that is effected by that action
	TargetType *string `json:"targetType,omitempty"`
}

type CancelPreflightRequestBody struct {
	PreflightActionExecutionId uuid.UUID `json:"preflightActionExecutionId"`

	// State Any kind of action specific state that will be passed to the next endpoints.
	State PreflightState `json:"state"`
}

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

type CancelResult struct {
	// Error An enhanced version of RFC 7807 Problem Details for HTTP APIs compliant response body for error scenarios
	Error *PreflightKitError `json:"error,omitempty"`

	// Modifications A list of execution modifications (e.g. property updates) Any of
	//   - `preflight_kit_api.ExecutionModificationSetPropertyValue`
	//   - `preflight_kit_api.ExecutionModificationAddValueToListProperty`
	Modifications *ExecutionModifications `json:"modifications,omitempty"`

	// Summary A short summary that will be displayed in the experiment execution details.
	Summary *Summary `json:"summary,omitempty"`
}

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

type DescribingEndpointReference struct {
	Method ReadHttpMethod `json:"method"`

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

type ExecutionModification interface{}

type ExecutionModificationAddValueToListProperty struct {
	// PropertyKey The key of the property.
	PropertyKey string `json:"propertyKey"`

	// Type The type of the modification. Needs to be set to `preflight_kit_api.AddValueToListProperty`.
	Type ExecutionModificationAddValueToListPropertyType `json:"type"`

	// Value The value to add.
	Value interface{} `json:"value"`
}

type ExecutionModificationAddValueToListPropertyType string

type ExecutionModificationSetPropertyValue struct {
	// PropertyKey The key of the property.
	PropertyKey string `json:"propertyKey"`

	// Type The type of the modification. Needs to be set to `preflight_kit_api.SetPropertyValue`.
	Type ExecutionModificationSetPropertyValueType `json:"type"`

	// Value The value to set.
	Value interface{} `json:"value"`
}

type ExecutionModificationSetPropertyValueType string

type ExecutionModifications = []ExecutionModification

type ExperimentExecutionAO struct {
	// CanceledBy The user that connected the hub
	CanceledBy *UserSummaryAO `json:"canceledBy,omitempty"`

	// Created Timestamp when the experiment was created
	Created *time.Time `json:"created,omitempty"`

	// CreatedBy The user that connected the hub
	CreatedBy *UserSummaryAO `json:"createdBy,omitempty"`

	// CreatedVia The creation trigger that caused this experiment execution to be started
	CreatedVia *ExperimentExecutionAOCreatedVia `json:"createdVia,omitempty"`

	// Ended Timestamp when the experiment ended
	Ended *time.Time `json:"ended,omitempty"`

	// ExperimentVersion Experiment design version which can be used to identify changes between experiment runs
	ExperimentVersion *int32 `json:"experimentVersion,omitempty"`

	// Hypothesis The hypothesis that is validated by the experiment
	Hypothesis *string `json:"hypothesis,omitempty"`

	// Id Unique experiment execution id that identifies this specific experiment execution
	Id *int32 `json:"id,omitempty"`

	// Key Unique experiment key that identifies the experiment. Combination of `team key` and increasing number
	Key *string `json:"key,omitempty"`

	// Name Name of the experiment to easily identify the experiment
	Name *string `json:"name,omitempty"`

	// Properties The properties of the experiment execution
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// PropertiesVersion Version of the properties for optimistic locking (optional in the Update-API)
	PropertiesVersion *int32 `json:"propertiesVersion,omitempty"`

	// Reason Reason in case the experiment execution failed or errored
	Reason *string `json:"reason,omitempty"`

	// Requested Timestamp when the experiment was requested
	Requested *time.Time `json:"requested,omitempty"`

	// Started Timestamp when the experiment was started
	Started *time.Time `json:"started,omitempty"`

	// State Current state of the experiment (e.g. CREATED, RUNNING, FAILED, ERRORED, COMPLETED)
	State *string `json:"state,omitempty"`

	// Steps The steps that are executed in parallel or sequence in the experiment.
	Steps *[]AbstractExperimentExecutionStepAO `json:"steps,omitempty"`

	// Variables Variables and their origins that have been used for this execution
	Variables *map[string]ExperimentExecutionVariableAO `json:"variables,omitempty"`
}

type ExperimentExecutionAOCreatedVia string

type ExperimentExecutionStepActionAO struct {
	// ActionId Unique identifier of the action that is executed in this step
	ActionId *string `json:"actionId,omitempty"`

	// ActionKind Kind of the action (e.g. attack, check, loadtest)
	ActionKind *ExperimentExecutionStepActionAOActionKind `json:"actionKind,omitempty"`

	// CustomLabel Custom label assigned during experiment design to express the intention of this step
	CustomLabel *string `json:"customLabel,omitempty"`

	// Ended Timestamp when this experiment step ended
	Ended *time.Time `json:"ended,omitempty"`

	// Id Unique identifier of this step execution
	Id *openapi_types.UUID `json:"id,omitempty"`

	// IgnoreFailure Whether the experiment should fail/error immediately in case this step fails/errors.
	IgnoreFailure *bool `json:"ignoreFailure,omitempty"`

	// Parameters Step-specific parameters of the experiment step configuration
	Parameters *map[string]interface{} `json:"parameters,omitempty"`

	// PredecessorId Unique identifier of the step execution that precedes this step, null if it is the first step of a lane
	PredecessorId *openapi_types.UUID `json:"predecessorId,omitempty"`

	// Radius Blast radius that is applied to define the set of targets as well as an optional random subset
	Radius *BlastRadiusAO `json:"radius,omitempty"`

	// Reason Reason in case this experiment step execution failed or errored
	Reason *string `json:"reason,omitempty"`

	// Started Timestamp when this experiment step was started
	Started *time.Time `json:"started,omitempty"`

	// State Current state of this step in the experiment (e.g. RUNNING, FAILED, ERRORED, COMPLETED)
	State *string `json:"state,omitempty"`

	// StepType Type of this step execution (e.g. ACTION, WAIT)
	StepType string `json:"stepType"`

	// TargetExecutions List of targets that are expected to be effected by this action. This list may change in case targets aren't available at the specific time of execution
	TargetExecutions *[]TargetExecutionAO `json:"targetExecutions,omitempty"`

	// TotalTargetCount Amount of targets that are effect int total
	TotalTargetCount *int64 `json:"totalTargetCount,omitempty"`
}

type ExperimentExecutionStepActionAOActionKind string

type ExperimentExecutionStepWaitAO struct {
	// CustomLabel Custom label assigned during experiment design to express the intention of this step
	CustomLabel *string `json:"customLabel,omitempty"`

	// Ended Timestamp when this experiment step ended
	Ended *time.Time `json:"ended,omitempty"`

	// Id Unique identifier of this step execution
	Id *openapi_types.UUID `json:"id,omitempty"`

	// IgnoreFailure Whether the experiment should fail/error immediately in case this step fails/errors.
	IgnoreFailure *bool `json:"ignoreFailure,omitempty"`

	// Parameters Step-specific parameters of the experiment step configuration
	Parameters *map[string]interface{} `json:"parameters,omitempty"`

	// PredecessorId Unique identifier of the step execution that precedes this step, null if it is the first step of a lane
	PredecessorId *openapi_types.UUID `json:"predecessorId,omitempty"`

	// Reason Reason in case this experiment step execution failed or errored
	Reason *string `json:"reason,omitempty"`

	// Started Timestamp when this experiment step was started
	Started *time.Time `json:"started,omitempty"`

	// State Current state of this step in the experiment (e.g. RUNNING, FAILED, ERRORED, COMPLETED)
	State *string `json:"state,omitempty"`

	// StepType Type of this step execution (e.g. ACTION, WAIT)
	StepType string `json:"stepType"`
}

type ExperimentExecutionVariableAO struct {
	Origin *ExperimentExecutionVariableAOOrigin `json:"origin,omitempty"`
	Value  *string                              `json:"value,omitempty"`
}

type ExperimentExecutionVariableAOOrigin string

type MutatingEndpointReference struct {
	Method MutatingHttpMethod `json:"method"`

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

type MutatingEndpointReferenceWithCallInterval struct {
	// CallInterval At what frequency should the state endpoint be called? Takes durations in the format of `100ms` or `10s`.
	CallInterval *string            `json:"callInterval,omitempty"`
	Method       MutatingHttpMethod `json:"method"`

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

type MutatingHttpMethod string

type PreflightDescription struct {
	// Cancel HTTP endpoint which the Steadybit platform/agent could communicate with.
	Cancel *MutatingEndpointReference `json:"cancel,omitempty"`

	// Description Description for end-users to help them understand what the preflight is doing.
	Description string `json:"description"`

	// Icon An icon that is used to identify your preflight in the ui. Needs to be a data-uri containing an image.
	Icon *string `json:"icon,omitempty"`

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

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

	// Start HTTP endpoint which the Steadybit platform/agent could communicate with.
	Start MutatingEndpointReference `json:"start"`

	// Status HTTP endpoint which the Steadybit platform/agent could communicate with.
	Status MutatingEndpointReferenceWithCallInterval `json:"status"`

	// TargetAttributeIncludes A list of attributes of targets that are populated to the preflight in the experiment execution. If the list is empty, no attributes are populated.
	TargetAttributeIncludes []string `json:"targetAttributeIncludes"`

	// Version The version of the preflight. Remember to increase the value everytime you update the definitions. The platform will ignore any definition changes with the same preflight version. We do recommend usage of semver strings.
	Version string `json:"version"`
}

type PreflightKitError 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"`

	// Status * failed - The preflight has detected some failures, for example a failing test which has been implemented by the preflight. The preflight will be canceled, if this status is returned by the status endpoint. * errored - There was a technical error while executing the preflight. Will be marked as red in the platform. The preflight will be canceled, if this status is returned by the status endpoint.
	Status *PreflightKitErrorStatus `json:"status,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 PreflightKitErrorStatus string

type PreflightList struct {
	Preflights []DescribingEndpointReference `json:"preflights"`
}

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

type PreflightState map[string]interface{}

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

type ReadHttpMethod string

type StartPreflightRequestBody struct {
	// ExperimentExecution A single experiment execution that was triggered from a single experiment.
	ExperimentExecution        ExperimentExecutionAO `json:"experimentExecution"`
	PreflightActionExecutionId uuid.UUID             `json:"preflightActionExecutionId"`
}

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

type StartResult struct {
	// Error An enhanced version of RFC 7807 Problem Details for HTTP APIs compliant response body for error scenarios
	Error *PreflightKitError `json:"error,omitempty"`

	// Modifications A list of execution modifications (e.g. property updates) Any of
	//   - `preflight_kit_api.ExecutionModificationSetPropertyValue`
	//   - `preflight_kit_api.ExecutionModificationAddValueToListProperty`
	Modifications *ExecutionModifications `json:"modifications,omitempty"`

	// State Any kind of action specific state that will be passed to the next endpoints.
	State PreflightState `json:"state"`

	// Summary A short summary that will be displayed in the experiment execution details.
	Summary *Summary `json:"summary,omitempty"`
}

type StatusPreflightRequestBody struct {
	PreflightActionExecutionId uuid.UUID `json:"preflightActionExecutionId"`

	// State Any kind of action specific state that will be passed to the next endpoints.
	State PreflightState `json:"state"`
}

type StatusResult struct {
	// Completed the agent will continue to poll the status endpoint as long as completed is false and no error is set
	Completed bool `json:"completed"`

	// Error An enhanced version of RFC 7807 Problem Details for HTTP APIs compliant response body for error scenarios
	Error *PreflightKitError `json:"error,omitempty"`

	// Modifications A list of execution modifications (e.g. property updates) Any of
	//   - `preflight_kit_api.ExecutionModificationSetPropertyValue`
	//   - `preflight_kit_api.ExecutionModificationAddValueToListProperty`
	Modifications *ExecutionModifications `json:"modifications,omitempty"`

	// State Any kind of action specific state that will be passed to the next endpoints.
	State *PreflightState `json:"state,omitempty"`

	// Summary A short summary that will be displayed in the experiment execution details.
	Summary *Summary `json:"summary,omitempty"`
}

type Summary struct {
	// Level The severity level of the summary.
	Level SummaryLevel `json:"level"`

	// Text The text to be displayed in the summary.
	Text string `json:"text"`
}

type SummaryLevel string

type TargetExecutionAO struct {
	// AgentHostname The agent that processed this target-action command and forwarded it to the proper extension instance.
	AgentHostname *string `json:"agentHostname,omitempty"`

	// Attributes A set of attributes that have been discovered for this target. A key may be associated multiple time to a single target.
	Attributes *[]AttributeAO `json:"attributes,omitempty"`

	// Name Identifier of the target that is expected to be effected
	Name *string `json:"name,omitempty"`

	// Reason Reason on a per target-level why the experiment failed or errored. If this step didn't failed or errored (`state != 'FAILED' and state != 'ERRORED') the reason is `null`.
	Reason *string `json:"reason,omitempty"`

	// ReasonDetails Optional additional reason details on a per target-level why the the experiment failed or errored.
	ReasonDetails *string `json:"reasonDetails,omitempty"`

	// Source The source (i.e. call to the extension) that caused the step to error or fail.
	Source *string `json:"source,omitempty"`

	// State State of this specific step on a per target-level.
	State *string `json:"state,omitempty"`

	// Summary A summary for a target execution
	Summary *TargetExecutionSummaryAO `json:"summary,omitempty"`

	// Type Type of the target that is expected to be effected
	Type *string `json:"type,omitempty"`
}

type TargetExecutionSummaryAO struct {
	Level *string `json:"level,omitempty"`
	Text  *string `json:"text,omitempty"`
}

type TargetPredicate = map[string]interface{}

type UserSummaryAO struct {
	Email *string `json:"email,omitempty"`

	// Name Name of the user
	Name       *string `json:"name,omitempty"`
	PictureUrl *string `json:"pictureUrl,omitempty"`

	// Username Username of the user, internal identifier of Steadybit
	Username string `json:"username"`
}