info

Documentation

Index

• type Documentation
• type FieldOption
• type FieldOptionSelectItem
• type FieldOptionType
• type Platform
  • func (p Platform) Short() Platform
• type Subprotocol

Types

type Documentation

type Documentation struct {
	Title string `json:"title,omitempty"`
	Link  string `json:"link"`
}

Documentation object info

type FieldOption

type FieldOption struct {
	Name        string                  `json:"name"`
	Required    bool                    `json:"required,omitempty"`
	Type        FieldOptionType         `json:"type,omitempty"`
	Description string                  `json:"description,omitempty"`
	Default     any                     `json:"default,omitempty"`
	Select      []FieldOptionSelectItem `json:"select,omitempty"` // Available variants
}

FieldOption description

type FieldOptionSelectItem

type FieldOptionSelectItem struct {
	Name        string `json:"name,omitempty"`
	Value       any    `json:"value"`
	Description string `json:"description,omitempty"`
	Link        string `json:"link,omitempty"`
}

FieldOptionSelectItem describes variant of option

type FieldOptionType

type FieldOptionType string

FieldOptionType of value

const (
	FieldOptionString          FieldOptionType = "string"
	FieldOptionInt             FieldOptionType = "int"
	FieldOptionFloat           FieldOptionType = "float"
	FieldOptionBool            FieldOptionType = "bool"
	FieldOptionStringStringMap FieldOptionType = "map[string]string"
)

InfoFieldOption types

type Platform

type Platform struct {
	Name         string          `json:"name,omitempty"`
	Protocol     string          `json:"protocol"`
	AllProtocols []string        `json:"all_protocols,omitempty"`
	Versions     []string        `json:"versions,omitempty"`
	Description  string          `json:"description,omitempty"`
	Docs         []Documentation `json:"docs,omitempty"`
	Options      []*FieldOption  `json:"options,omitempty"`
	Subprotocols []Subprotocol   `json:"subprotocols,omitempty"`
}

Platform info driver description

func (Platform) Short

func (p Platform) Short() Platform

Short information

type Subprotocol

type Subprotocol struct {
	Name        string          `json:"name,omitempty"`
	Protocol    string          `json:"protocol"`
	Versions    []string        `json:"versions,omitempty"`
	Description string          `json:"description,omitempty"`
	Docs        []Documentation `json:"docs,omitempty"`
}

Subprotocol needed for describing of subprotocols support. For example OpenRTB supports many subformats like VAST, OpenNative, etc.