models

Documentation

Index

• type ApplicationConfig
• type Config
• type DatabaseEnv
• type Envs
• type Item
• type LevelledLogs
• type PersistenceLocation
• type ServerConfig
• type ServerEnv

Types

type ApplicationConfig

type ApplicationConfig struct {
	APIPrefix    string       `json:"api_prefix,omitempty"`    // APIPrefix defines the prefix for the API endpoints
	LevelledLogs LevelledLogs `json:"levelled_logs,omitempty"` // LevelledLogs contains all the application logging-related configuration.
}

ApplicationConfig contains application-related configuration.

type Config

type Config struct {
	ServerConfig      ServerConfig      `json:"server_config,omitempty"`      // ServerConfig contains server-related configuration.
	ApplicationConfig ApplicationConfig `json:"application_config,omitempty"` // ApplicationConfig contains application-related configuration.
}

Config contains all the configuration-related to server and application.

type DatabaseEnv

type DatabaseEnv struct {
	Uri      string `json:"uri,omitempty"`      // Uri defines the uri at which server is initiated.
	Port     string `json:"port,omitempty"`     // Port defines the port at which server is initiated.
	Username string `json:"username,omitempty"` // Username specifies the user used for database login.
	Password string `json:"password,omitempty"` // Password specifies the password used for database login.
}

DatabaseEnv contains all the database

type Envs

type Envs struct {
	ServerEnv   ServerEnv   `json:"server,omitempty"` // ServerEnv specifies the server environment variables.
	DatabaseEnv DatabaseEnv `json:"db,omitempty"`     // DatabaseEnv specifies the database environment variables.
}

Envs contains all the environment variables which is used in the dev setup.

type Item

type Item struct {
	ID   int64
	Name string
}

Item defines the structure of an API item

type LevelledLogs

type LevelledLogs struct {
	PersistenceLocation   PersistenceLocation `json:"persistence_location,omitempty"`
	EnableLoggingToFile   bool                `json:"enable_logging_to_file,omitempty"`
	EnableLoggingToStdout bool                `json:"enable_logging_to_stdout,omitempty"`
	EnableColors          bool                `json:"enable_colors,omitempty"`
	EnableFullTimestamp   bool                `json:"enable_full_timestamp,omitempty"`
	OutputFormatter       string              `json:"output_formatter"`
}

LevelledLogs contains all the application logging-related configuration.

type PersistenceLocation

type PersistenceLocation struct {
	ContainerDirectory  string   `json:"container_directory,omitempty"`
	TargetFileName      []string `json:"targetfile_name,omitempty"`
	TargetFileExtension string   `json:"targetfile_extension,omitempty"`
}

PersistenceLocation contains file-system-related configurations.

type ServerConfig

type ServerConfig struct {
	EnvironmentType string `json:"environment_type,omitempty"` // EnvironmentType indicates the environment being used.
	DevEnvs         Envs   `json:"dev_env,omitempty"`          // DevEnvs contains all the environment variables which is used in the dev setup.
	StagEnvs        Envs   `json:"stag_env,omitempty"`         // StagEnvs contains all the environment variables which is used in the dev setup.
	ProdEnvs        Envs   `json:"prod_envs,omitempty"`        // ProdEnvs contains all the environment variables which is used in the production setup.
}

ServerConfig contains server-related configuration.

type ServerEnv

type ServerEnv struct {
	Uri          string `json:"uri,omitempty"`            // Uri defines the uri at which server is initiated.
	Port         string `json:"port,omitempty"`           // Port defines the port at which server is initiated.
	WriteTimeout int    `json:"write_timeout,omitempty"`  // WriteTimeout defines the write timeout for the server.
	ReadTimeout  int    `json:"read_timeout,omitempty"`   // ReadTimeout defines the read timeout for the server.
	IsTLSEnabled bool   `json:"is_tls_enabled,omitempty"` // IsTLSEnabled specifies if TLS is to be enabled.
}

ServerEnv contains all the go-server related configurations.