types

Documentation

Index

• type BuildPackage
• type BuildPackageSubmodule
• type Entity
• type FunnelList
• type IBLProject
• type TargetType
• type TypeGen
• type WebhookFunnel
  • func (w WebhookFunnel) String() string

Types

type BuildPackage

type BuildPackage struct {
	Language   string                  `yaml:"language" validate:"required"`        // Language of the package
	LangOpts   map[string]string       `yaml:"lang_opts"`                           // Language specific options
	Submodules []BuildPackageSubmodule `yaml:"submodules" validate:"dive,required"` // List of submodules
	Env        map[string]string       `yaml:"env"`                                 // The default env to use                           // Environment variables

	// Common flags
	User    string `yaml:"user" validate:"required"`    // Which user account the project is under
	Project string `yaml:"project" validate:"required"` // Name of the project
	Binary  string `yaml:"binary" validate:"required"`  // Name of the binary
	Service string `yaml:"service"`                     // Name of the service
}

BuildPackage represents the format of a ibl pkg

type BuildPackageSubmodule

type BuildPackageSubmodule struct {
	Name string `yaml:"name" validate:"required"` // Name of the submodule
	Path string `yaml:"path" validate:"required"` // Path to the submodule
}

type Entity

type Entity struct {
	TargetType TargetType
	ID         string
	Name       string
}

Internal struct defining a iblcli entity

type FunnelList

type FunnelList struct {
	Port    int             `yaml:"port"`
	Domain  string          `yaml:"domain"`
	Funnels []WebhookFunnel `yaml:"funnels"`
}

type IBLProject

type IBLProject struct {
	Pkg     *BuildPackage `yaml:"pkg"`     // `ibl pkg` config
	TypeGen *TypeGen      `yaml:"typegen"` // `ibl typegen` config
}

IBLProject represents the format of a ibl project.yaml file

type TargetType

type TargetType = string

const (
	TargetTypeUser   TargetType = "user"
	TargetTypeBot    TargetType = "bot"
	TargetTypeServer TargetType = "server"

	// Cannot be logged into, but still a target type
	TargetTypeTeam TargetType = "team"
)

type TypeGen

type TypeGen struct {
	Path     string   `yaml:"path" validate:"required"`     // Path to copy types from
	Projects []string `yaml:"projects" validate:"required"` // List of projects to copy types to
}

TypeGen represents the format of a ibl typegen config

type WebhookFunnel

type WebhookFunnel struct {
	TargetType TargetType `yaml:"target_type"`
	TargetID   string     `yaml:"target_id"`
	EndpointID string     `yaml:"endpoint_id"`
	Forward    string     `yaml:"forward"`

	// Hidden from String(), sensitive
	WebhookSecret string `yaml:"webhook_secret"`
}

func (WebhookFunnel) String

func (w WebhookFunnel) String() string