version

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• type Config
  • func DefaultConfig() Config
• type Endpoint
  • func New(config Config) (*Endpoint, error)
  • func (e *Endpoint) Decoder() kithttp.DecodeRequestFunc
  • func (e *Endpoint) Encoder() kithttp.EncodeResponseFunc
  • func (e *Endpoint) Endpoint() kitendpoint.Endpoint
  • func (e *Endpoint) Method() string
  • func (e *Endpoint) Middlewares() []kitendpoint.Middleware
  • func (e *Endpoint) Name() string
  • func (e *Endpoint) Path() string
• type Response
  • func DefaultResponse() *Response

Constants

const (
	// Method is the HTTP method this endpoint is registered for.
	Method = "GET"
	// Name identifies the endpoint. It is aligned to the package path.
	Name = "version"
	// Path is the HTTP request path this endpoint is registered for.
	Path = "/"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	// Dependencies.
	Logger     micrologger.Logger
	Middleware *middleware.Middleware
	Service    *service.Service
}

Config represents the configuration used to create a version endpoint.

func DefaultConfig

func DefaultConfig() Config

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

type Endpoint

type Endpoint struct {
	Config
}

func New

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

New creates a new configured version endpoint.

func (*Endpoint) Decoder

func (e *Endpoint) Decoder() kithttp.DecodeRequestFunc

func (*Endpoint) Encoder

func (e *Endpoint) Encoder() kithttp.EncodeResponseFunc

func (*Endpoint) Endpoint

func (e *Endpoint) Endpoint() kitendpoint.Endpoint

func (*Endpoint) Method

func (e *Endpoint) Method() string

func (*Endpoint) Middlewares

func (e *Endpoint) Middlewares() []kitendpoint.Middleware

func (*Endpoint) Name

func (e *Endpoint) Name() string

func (*Endpoint) Path

func (e *Endpoint) Path() string

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.