version

Documentation

Index

• func IsInvalidConfig(err error) bool
• type Config
  • func DefaultConfig() Config
• type Request
  • func DefaultRequest() Request
• type Response
  • func DefaultResponse() *Response
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) Get(ctx context.Context, request Request) (*Response, error)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	// Settings.
	Description string
	GitCommit   string
	Name        string
	Source      string
}

Config represents the configuration used to create a version service.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new version service by best effort.

type Request

type Request struct {
}

Request is the configuration for the service action.

func DefaultRequest

func DefaultRequest() Request

DefaultRequest provides a default request object by best effort.

type Response

type Response struct {
	Description string `json:"description"`
	GitCommit   string `json:"git_commit"`
	GoVersion   string `json:"go_version"`
	Name        string `json:"name"`
	OSArch      string `json:"os_arch"`
	Source      string `json:"source"`
}

Response is the return value of the service action.

func DefaultResponse

func DefaultResponse() *Response

DefaultResponse provides a default response object by best effort.

type Service

type Service struct {
	Config
}

Service implements the version service interface.

func New

func New(config Config) (*Service, error)

New creates a new configured version service.

func (*Service) Get

func (s *Service) Get(ctx context.Context, request Request) (*Response, error)