config

Documentation

Index

• type Auth
• type Config
• type Table

Types

type Auth

type Auth struct {
	Username     string
	PasswordHash string
}

Auth stores the username and password hash. Inbound HTTP request must be authenticated over HTTP Basic Auth and the credentials provided by the client will be compared to values stored here

type Config

type Config struct {
	Name        string
	DisplayName string
	Description string
	Port        string
	Database    struct {
		Driver string
		URL    string
		Tables []*Table
	}
	TLS struct {
		Enabled    bool
		PublicKey  string
		PrivateKey string
	}
	Descriptor *descriptor.Descriptor
	Auth       *Auth
	Logging    bool
}

Config defines the data structures which can be used and configured in the config.yaml file and other relevant data structures

var Options Config

Options is populated by this package's init() function

type Table

type Table struct {
	Name               string
	ColumnAsOptionName string
}

Table defines the name of the database table that will be queried and the table column which will be the `name` field when the query results are formatted for option routes.