app

Documentation

Index

• func MountHealthController(service *goa.Service, ctrl HealthController)
• func MountPublicController(service *goa.Service, ctrl PublicController)
• type HealthController
• type HealthHealthContext
  • func NewHealthHealthContext(ctx context.Context, r *http.Request, service *goa.Service) (*HealthHealthContext, error)
  • func (ctx *HealthHealthContext) OK(r *JSON) error
• type JSON
  • func (mt *JSON) Validate() (err error)
• type PublicController

Functions

func MountHealthController

func MountHealthController(service *goa.Service, ctrl HealthController)

MountHealthController "mounts" a Health resource controller on the given service.

func MountPublicController

func MountPublicController(service *goa.Service, ctrl PublicController)

MountPublicController "mounts" a Public resource controller on the given service.

Types

type HealthController

type HealthController interface {
	goa.Muxer
	Health(*HealthHealthContext) error
}

HealthController is the controller interface for the Health actions.

type HealthHealthContext

type HealthHealthContext struct {
	context.Context
	*goa.ResponseData
	*goa.RequestData
}

HealthHealthContext provides the health health action context.

func NewHealthHealthContext

func NewHealthHealthContext(ctx context.Context, r *http.Request, service *goa.Service) (*HealthHealthContext, error)

NewHealthHealthContext parses the incoming request URL and body, performs validations and creates the context used by the health controller health action.

func (*HealthHealthContext) OK

func (ctx *HealthHealthContext) OK(r *JSON) error

OK sends a HTTP response with status code 200.

type JSON

type JSON struct {
	// status code
	Code int `form:"code" json:"code" yaml:"code" xml:"code"`
	// system status
	Status string `form:"status" json:"status" yaml:"status" xml:"status"`
}

Health Check (default view)

Identifier: application/json; view=default

func (*JSON) Validate

func (mt *JSON) Validate() (err error)

Validate validates the JSON media type instance.

type PublicController

type PublicController interface {
	goa.Muxer
	goa.FileServer
}

PublicController is the controller interface for the Public actions.