manifest

Documentation

Index

• type Manifest
• type Usage
• type UsageDesc

Types

type Manifest

type Manifest struct {
	Category    string `json:"category"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Driver      string `json:"driver"`
	// Note: You don't need to specify the Entrypoint field, When develop a new std function.
	// Because the Entrypoint field is automatically filled in, When register the new function into std.
	Entrypoint     string            `json:"entrypoint"`
	Args           map[string]string `json:"args"`
	RetryOnFailure int               `json:"retry_on_failure"`
	IgnoreFailure  bool              `json:"ignore_failure"`
	Usage          Usage             `json:"usage"`
}

type Usage

type Usage struct {
	Args         []UsageDesc `json:"args"`
	ReturnValues []UsageDesc `json:"return_values"`
}

type UsageDesc

type UsageDesc struct {
	Name           string   `json:"name"`
	OptionalValues []string `json:"optional_values"`
	Desc           string   `json:"desc"`
}