Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var AvailableTaskDescriptors = []*types.TaskDescriptor{ checkclientsarehealthy.TaskDescriptor, checkconsensusattestationstats.TaskDescriptor, checkconsensusblockproposals.TaskDescriptor, checkconsensusbuildersstatus.TaskDescriptor, checkconsensusfinality.TaskDescriptor, checkconsensusforks.TaskDescriptor, checkconsensusidentity.TaskDescriptor, checkconsensusproposerduty.TaskDescriptor, checkconsensusreorgs.TaskDescriptor, checkconsensusslotrange.TaskDescriptor, checkconsensussyncstatus.TaskDescriptor, checkconsensusvalidatorstatus.TaskDescriptor, checkexecutionblock.TaskDescriptor, checkethcall.TaskDescriptor, checkethconfig.TaskDescriptor, checkexecutionsyncstatus.TaskDescriptor, generateattestations.TaskDescriptor, generateblobtransactions.TaskDescriptor, generateblschanges.TaskDescriptor, generatechildwallet.TaskDescriptor, generateconsolidations.TaskDescriptor, generateeoatransactions.TaskDescriptor, generatedeposits.TaskDescriptor, generateexits.TaskDescriptor, generateslashings.TaskDescriptor, generatetransaction.TaskDescriptor, generatewithdrawalrequests.TaskDescriptor, getpubkeysfrommnemonic.TaskDescriptor, getconsensusspecs.TaskDescriptor, getconsensusvalidators.TaskDescriptor, getrandommnemonic.TaskDescriptor, getwalletdetails.TaskDescriptor, runcommand.TaskDescriptor, runexternaltasks.TaskDescriptor, runshell.TaskDescriptor, runspamoorscenario.TaskDescriptor, runtaskbackground.TaskDescriptor, runtaskmatrix.TaskDescriptor, runtaskoptions.TaskDescriptor, runtasks.TaskDescriptor, runtasksconcurrent.TaskDescriptor, sleep.TaskDescriptor, }
Functions ¶
func GenerateJSONSchema ¶
func GenerateJSONSchema(v any) (json.RawMessage, error)
GenerateJSONSchema generates a JSON Schema from a Go struct via reflection. The value v is used both for type information and for extracting default values.
func GetTaskDescriptor ¶
func GetTaskDescriptor(name string) *types.TaskDescriptor
Types ¶
type JSONSchema ¶
type JSONSchema struct {
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
Description string `json:"description,omitempty"`
Properties map[string]*JSONSchema `json:"properties,omitempty"`
PropertyOrder []string `json:"propertyOrder,omitempty"`
Required []string `json:"required,omitempty"`
Items *JSONSchema `json:"items,omitempty"`
Default any `json:"default,omitempty"`
Enum []any `json:"enum,omitempty"`
AdditionalProperties *JSONSchema `json:"additionalProperties,omitempty"`
// RequireGroup specifies requirement groups for this field.
// Format: "A" or "A.1" where A is the group and .1 is the subgroup.
// Fields in same subgroup must all be present together.
// Multiple subgroups (A.1, A.2) are alternatives - one must be satisfied.
RequireGroup string `json:"requireGroup,omitempty"`
}
JSONSchema represents a JSON Schema object.
type MapOfRunnableInfo ¶
type MapOfRunnableInfo map[string]RunnableInfo
func AvailableTasks ¶
func AvailableTasks() MapOfRunnableInfo
type RunnableInfo ¶
type RunnableInfo struct {
Description string
Config interface{}
}
RunnableInfo contains information about a runnable task.
type TaskDescriptorAPI ¶
type TaskDescriptorAPI struct {
Name string `json:"name"`
Aliases []string `json:"aliases,omitempty"`
Description string `json:"description"`
Category string `json:"category,omitempty"`
ConfigSchema json.RawMessage `json:"configSchema"`
Outputs []types.TaskOutputDefinition `json:"outputs,omitempty"`
}
TaskDescriptorAPI represents a task descriptor for API responses.
func GetAllTaskDescriptorsAPI ¶
func GetAllTaskDescriptorsAPI() []TaskDescriptorAPI
GetAllTaskDescriptorsAPI returns all task descriptors formatted for API responses.
func GetTaskDescriptorAPI ¶
func GetTaskDescriptorAPI(name string) *TaskDescriptorAPI
GetTaskDescriptorAPI returns a single task descriptor formatted for API response.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.