presenter

Documentation

Index

• func ServerEmptyResponse() *fiber.Map
• func ServerErrorResponse(err error) *fiber.Map
• func ServerSuccessResponse(data *types.Server) *fiber.Map
• func SetupErrorResponse(err error) *fiber.Map
• func SetupSuccessResponse(data config.Config) *fiber.Map
• func StatusErrorResponse(err error) *fiber.Map
• func StatusSuccessResponse(data Status) *fiber.Map
• type Status

Functions

func ServerEmptyResponse

func ServerEmptyResponse() *fiber.Map

ServerEmptyResponse is a successful response where no server is found that will be passed in the response by handler.

func ServerErrorResponse

func ServerErrorResponse(err error) *fiber.Map

ServerErrorResponse is the singular ErrorResponse that will be passed in the response by handler.

func ServerSuccessResponse

func ServerSuccessResponse(data *types.Server) *fiber.Map

ServerSuccessResponse is the SuccessResponse that will be passed in the response by handler.

func SetupErrorResponse

func SetupErrorResponse(err error) *fiber.Map

SetupErrorResponse is the singular ErrorResponse that will be passed in the response by handler.

func SetupSuccessResponse

func SetupSuccessResponse(data config.Config) *fiber.Map

SetupSuccessResponse is the SuccessResponse that will be passed in the response by handler.

func StatusErrorResponse

func StatusErrorResponse(err error) *fiber.Map

SetupErrorResponse is the singular ErrorResponse that will be passed in the response by handler.

func StatusSuccessResponse

func StatusSuccessResponse(data Status) *fiber.Map

SetupSuccessResponse is the SuccessResponse that will be passed in the response by handler.

Types

type Status

type Status struct {
	Type    string `json:"type" yaml:"type" xml:"type" form:"type"`             // The type of status e.g. "healthy".
	Message string `json:"message" yaml:"message" xml:"message" form:"message"` // The message returned by the api.
}