webservice

Documentation

Index

• Constants
• type ProblemDetails
  • func (pd *ProblemDetails) Error() string
• type WebService
  • func NewWebService(cfg config.YHSConfig, repository repository.Repository, ...) *WebService
  • func (ws *WebService) LivenessHealthcheck(req *restful.Request, resp *restful.Response)
  • func (ws *WebService) ReadinessHealthcheck(req *restful.Request, resp *restful.Response)
  • func (ws *WebService) Shutdown(ctx context.Context) error
  • func (ws *WebService) Start(ctx context.Context) error

Constants

const SwaggerUIHTML = `` /* 890-byte string literal not displayed */

Types

type ProblemDetails

type ProblemDetails struct {
	// Type is a URI reference that identifies the problem type.
	Type string `json:"type,omitempty"`
	// Title is a short, human-readable summary of the problem type.
	Title string `json:"title,omitempty"`
	// Status is the HTTP status code generated by the origin server for this occurrence of the problem.
	Status int `json:"status,omitempty"`
	// Detail is a human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail,omitempty"`
	// Instance is a URI reference that identifies the specific occurrence of the problem.
	Instance string `json:"instance,omitempty"`
}

ProblemDetails represents the problem details as per RFC 7807

func (*ProblemDetails) Error

func (pd *ProblemDetails) Error() string

type WebService

type WebService struct {
	// contains filtered or unexported fields
}

func NewWebService

func NewWebService(
	cfg config.YHSConfig,
	repository repository.Repository,
	eventRepository repository.EventRepository,
	healthService health.Interface,
) *WebService

func (*WebService) LivenessHealthcheck

func (ws *WebService) LivenessHealthcheck(req *restful.Request, resp *restful.Response)

func (*WebService) ReadinessHealthcheck

func (ws *WebService) ReadinessHealthcheck(req *restful.Request, resp *restful.Response)

func (*WebService) Shutdown

func (ws *WebService) Shutdown(ctx context.Context) error

func (*WebService) Start

func (ws *WebService) Start(ctx context.Context) error

Start performs a blocking call to start the REST API server.