rest

Documentation

Index

• type PingResponse
  • func (p PingResponse) MarshalJSON() ([]byte, error)
• type SystemEndpoints
  • func (h *SystemEndpoints) Register(router *mux.Router)

Types

type PingResponse

type PingResponse struct {
	Version string
}

PingResponse represents the response object returned by the ping endpoint

func (PingResponse) MarshalJSON

func (p PingResponse) MarshalJSON() ([]byte, error)

MarshalJSON amends PingResponse instances with type metadata.

type SystemEndpoints

type SystemEndpoints struct {
	APIServerVersion string
	DatabaseClient   *mongo.Client
	WriterFactory    queue.WriterFactory
}

SystemEndpoints implements restmachinery.Endpoints to provide System-related URL --> action mappings to a restmachinery.Server.

func (*SystemEndpoints) Register

func (h *SystemEndpoints) Register(router *mux.Router)

Register is invoked by restmachinery.Server to register System-related URL --> action mappings to a restmachinery.Server.