Categorygithub.com/steadybit/action-kit/go/action_kit_api/v2
modulepackage
2.9.4
Repository: https://github.com/steadybit/action-kit.git
Documentation: pkg.go.dev

# README

ActionKit Go API

This module exposes Go types that you will find helpful when implementing an ActionKit extension.

The types are generated automatically from the ActionKit OpenAPI specification.

Installation

Add the following to your go.mod file:

go get github.com/steadybit/action-kit/go/action_kit_api

Usage

import (
	"github.com/steadybit/action-kit/go/action_kit_api"
)

actionList := action_kit_api.ActionList{
    Actions: []action_kit_api.DescribingEndpointReference{
        {
            "GET",
            "/actions/rollout-restart",
        },
    },
}

# Functions

GetSwagger returns the Swagger specification corresponding to the generated code in this file.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

# Constants

Defines values for TargetSelectionQuantityRestriction.
Defines values for ActionKind.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionKind.
Defines values for LineChartWidgetType.
Defines values for LineChartWidgetGroupMatcherFallbackType.
Defines values for LineChartWidgetGroupMatcherKeyEqualsValueType.
Defines values for LineChartWidgetGroupMatcherNotEmptyType.
Defines values for LineChartWidgetIdentityConfigMode.
Defines values for LineChartWidgetIdentityConfigMode.
Defines values for LogWidgetType.
Defines values for MarkdownWidgetType.
Defines values for PredefinedWidgetType.
Defines values for StateOverTimeWidgetType.
Defines values for MessageLevel.
Defines values for MutatingHttpMethod.
Defines values for ActionDescriptionAdditionalFlags.
Defines values for ActionParameterType.
Defines values for MessageLevel.
Defines values for ActionKitErrorStatus.
Defines values for TargetSelectionQuantityRestriction.
Defines values for ActionKitErrorStatus.
Defines values for ActionParameterType.
Defines values for ReadHttpMethod.
Defines values for ActionParameterType.
Defines values for ActionHintType.
Defines values for ActionHintType.
Defines values for MessageLevel.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionKind.
Defines values for TargetSelectionQuantityRestriction.
Defines values for ActionKind.
Defines values for ActionParameterType.
POST
Defines values for MutatingHttpMethod.
Defines values for MutatingHttpMethod.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for ActionParameterType.
Defines values for TimeControl.
Defines values for TimeControl.
Defines values for TimeControl.
Defines values for TimestampSource.
Defines values for TimestampSource.
Defines values for ActionParameterType.
Defines values for MessageLevel.

# Structs

ActionDescription Provides details about a possible action, e.g., what configuration options it has, how to present it to end-users and how to trigger the action.
ActionHint Hints are used to provide additional information to the user.
ActionKitError An enhanced version of RFC 7807 Problem Details for HTTP APIs compliant response body for error scenarios.
ActionList Lists all actions that the platform/agent could execute.
ActionListResponse defines model for ActionListResponse.
ActionParameter defines model for ActionParameter.
ActionStatusRequestBody defines model for ActionStatusRequestBody.
ActionStatusResponse defines model for ActionStatusResponse.
Artifact Actions may choose to provide artifacts (arbitrary files) that are later accessible by users when inspecting experiment execution details.
DescribeActionResponse defines model for DescribeActionResponse.
DescribingEndpointReference HTTP endpoint which the Steadybit platform/agent could communicate with.
ExecutionContext The execution context contains information about the current execution of the action.
ExplicitParameterOption You can use an explicit/fixed parameter option for a known / finite set of options that never change.
LineChartWidget A widget that shows a line chart.
LineChartWidgetGroup A group of data points in the line chart.
LineChartWidgetGroupingConfig Optional configuration to group some data points in the line chart.
LineChartWidgetGroupMatcherFallback A fallback matcher that will match all data points that are not matched by any other group.
LineChartWidgetGroupMatcherKeyEqualsValue A matcher that will match all data points where the value of the specified key equals the specified value.
LineChartWidgetGroupMatcherNotEmpty A matcher that will match all data points where the value of the specified key is not empty.
LineChartWidgetIdentityConfig defines model for LineChartWidgetIdentityConfig.
LineChartWidgetTooltipConfig defines model for LineChartWidgetTooltipConfig.
LineChartWidgetTooltipContent defines model for LineChartWidgetTooltipContent.
LogWidget A widget that shows log messages.
MarkdownWidget A widget that renders Markdown content.
Message Log-message that will be passed to the platform (default agent log).
Metric Metrics can be exposed by actions.
MetricsConfiguration defines model for MetricsConfiguration.
MetricsQueryConfiguration defines model for MetricsQueryConfiguration.
MutatingEndpointReference HTTP endpoint which the Steadybit platform/agent could communicate with.
MutatingEndpointReferenceWithCallInterval defines model for MutatingEndpointReferenceWithCallInterval.
ParameterOptionsFromTargetAttribute A meta option that represents all target attribute values for the key defined through the attribute field.
PredefinedWidget The platform contains a set of hand crafted predefined widgets.
PrepareActionRequestBody defines model for PrepareActionRequestBody.
PrepareActionResponse defines model for PrepareActionResponse.
PrepareResult defines model for PrepareResult.
QueryMetricsRequestBody defines model for QueryMetricsRequestBody.
QueryMetricsResponse defines model for QueryMetricsResponse.
QueryMetricsResult defines model for QueryMetricsResult.
RestrictedEndpoint defines model for RestrictedEndpoint.
StartActionRequestBody defines model for StartActionRequestBody.
StartActionResponse defines model for StartActionResponse.
StartResult defines model for StartResult.
StateOverTimeWidget A widget that shows a state of over time.
StateOverTimeWidgetIdentityConfig defines model for StateOverTimeWidgetIdentityConfig.
StateOverTimeWidgetLabelConfig defines model for StateOverTimeWidgetLabelConfig.
StateOverTimeWidgetStateConfig defines model for StateOverTimeWidgetStateConfig.
StateOverTimeWidgetTooltipConfig defines model for StateOverTimeWidgetTooltipConfig.
StateOverTimeWidgetUrlConfig defines model for StateOverTimeWidgetUrlConfig.
StateOverTimeWidgetValueConfig defines model for StateOverTimeWidgetValueConfig.
StatusResult defines model for StatusResult.
StopActionRequestBody defines model for StopActionRequestBody.
StopActionResponse defines model for StopActionResponse.
StopResult defines model for StopResult.
Target The target on which to act on as identified by a discovery.
TargetSelection Used to specify various aspects of the target selection.
TargetSelectionTemplate defines model for TargetSelectionTemplate.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

ActionDescriptionAdditionalFlags defines model for ActionDescription.AdditionalFlags.
ActionHintType Will be used in the product UI to display the hint in a different color and with a different icon.
ActionKind Describes what kind of action this is.
ActionKitErrorStatus * failed - The action has detected some failures, for example a failing test which has been implemented by the action.
ActionParameterType What kind of value this parameter is capturing.
ActionState Any kind of action specific state that will be passed to the next endpoints.
Artifacts defines model for Artifacts.
LineChartWidgetGroupMatcherFallbackType The type of the widget.
LineChartWidgetGroupMatcherKeyEqualsValueType The type of the widget.
LineChartWidgetGroupMatcherNotEmptyType The type of the widget.
LineChartWidgetIdentityConfigMode If there are multiple values by evaluating `from`, how should the widgets be rendered? - `com.steadybit.widget.line_chart.identity_mode.select` - A single widget is rendered and the user can select the value that should be displayed in the widget.
LineChartWidgetType The type of the widget.
LogWidgetType The type of the widget.
MarkdownWidgetType The type of the widget.
MessageFields Any kind of action specific fields that will be rendered in the platform tooltip of LogWidget.
MessageLevel defines model for Message.Level.
Messages Log-messages that will be passed to the platform (default agent log).
Metrics defines model for Metrics.
MutatingHttpMethod defines model for MutatingHttpMethod.
PredefinedWidgetType The type of the widget.
ReadHttpMethod defines model for ReadHttpMethod.
StateOverTimeWidgetType The type of the widget.
TargetSelectionQuantityRestriction How many targets should be selected by the user.
TargetSelectionTemplates Users that want to configure an action with a targetType need to define a target selection through the query UI or query language.
TimeControl Actions can either be an instantaneous event, e.g., the restart of a host, or an activity spanning over an unspecified duration.
TimestampSource Source of the timestamp.
Widgets Widgets that will be rendered in the experiment result view after an experiment has finished.