health

Documentation

Index

• Variables
• func NewGetHealthEndpoint() endpoint.EndpointHandler
• type GetHealthEndpoint
  • func (ep GetHealthEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GetHealthRequest
• type GetHealthResponse

Variables

var (
	OpenAPITags = []api.Tag{
		{Name: "Health", Description: "Endpoints reporting the health of the application"},
	}
)

Functions

func NewGetHealthEndpoint

func NewGetHealthEndpoint() endpoint.EndpointHandler

Types

type GetHealthEndpoint

type GetHealthEndpoint struct {
	endpoint.Endpoint
}

https://golang.org/doc/effective_go#embedding

func (GetHealthEndpoint) ServeHTTP

func (ep GetHealthEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GetHealthRequest

type GetHealthRequest struct{}

type GetHealthResponse

type GetHealthResponse struct {
	Alive bool `json:"alive_json" oas-desc:"Tells if the service is alive (ping)"`
	Ready bool `json:"ready_json" oas-desc:"Tells if the service is ready to accept requests"`
}