docs

Documentation

Index

• func FormatVer(ver float32) string
• type Doc
• type DocFile
• type ParamDoc
  • func Get(param string, ver float32) (ParamDoc, error)

Functions

func FormatVer

func FormatVer(ver float32) string

FormatVer fixes the postgres versioning system and results a valid version

Types

type Doc

type Doc map[string]ParamDoc

Doc is a map with parameters

type DocFile

type DocFile struct {
	Documentation map[string]Doc `json:"documentation"`
}

DocFile is the json/yaml structure of the doc file

type ParamDoc

type ParamDoc struct {
	Title              string            `json:"name,omitempty" yaml:"title"`
	ShortDesc          string            `json:"short_desc,omitempty" yaml:"short_desc"`
	Text               []string          `json:"details,omitempty" yaml:"details"`
	DocURL             string            `json:"url,omitempty" yaml:"url"`
	ConfURL            string            `json:"conf_url,omitempty" yaml:"conf_url"`
	RecomendationsConf string            `json:"recomendations_conf,omitempty" yaml:"recomendations_conf"`
	ParamType          string            `json:"type,omitempty" yaml:"type"`
	DefaultValue       string            `json:"default_value,omitempty" yaml:"default_value"`
	MinValue           string            `json:"min_value,omitempty" yaml:"min_value"`
	MaxValue           string            `json:"max_value,omitempty" yaml:"max_value"`
	BlogRecomendations map[string]string `json:"recomendations,omitempty,omitempty" yaml:"recomendations,omitempty"`
	Abstract           string            `json:"abstract,omitempty" yaml:"abstract,omitempty"`
}

ParamDoc is foo

func Get

func Get(param string, ver float32) (ParamDoc, error)

Get queries conf website and gets the html from the webpage and parses it