Documentation
¶
Overview ¶
Package common is to handle REST API for common funcitonalities
Package common is to handle REST API for common funcitonalities
Index ¶
- func CheckHTTPVersion(c echo.Context) error
- func GetReadyz(c echo.Context) error
- func Send(c echo.Context, httpCode int, json interface{}) error
- func SendExistence(c echo.Context, httpCode int, existence bool) error
- func SendMessage(c echo.Context, httpCode int, msg string) error
- func TestTracing(c echo.Context) error
- func Validate(c echo.Context, params []string) error
- type Existence
- type SimpleMessage
- type Status
- type TbConnectionName
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckHTTPVersion ¶ added in v0.2.2
CheckHTTPVersion godoc @ID CheckHTTPVersion @Summary Check HTTP version of incoming request @Description Checks and logs the HTTP version of the incoming request to the server console. @Tags [Admin] System management @Accept json @Produce json @Param X-Request-Id header string false "Custom request ID (NOTE: It will be used as a trace ID.)" @Success 200 {object} SimpleMessage @Failure 404 {object} SimpleMessage @Failure 500 {object} SimpleMessage @Router /httpVersion [get]
func GetReadyz ¶ added in v0.2.2
GetReadyz godoc @ID GetReadyz @Summary Check Beetle is ready @Description Check Beetle is ready @Tags [Admin] System management @Accept json @Produce json @Param X-Request-Id header string false "Custom request ID (NOTE: It will be used as a trace ID.)" @Success 200 {object} SimpleMessage @Failure 503 {object} SimpleMessage @Router /readyz [get]
func TestTracing ¶ added in v0.2.2
TestTracing godoc @ID TestTracing @Summary Test tracing to Tumblebug @Description Test tracing to Tumblebug @Tags [Test] Utility @Accept json @Produce json @Param X-Request-Id header string false "Custom request ID (NOTE: It will be used as a trace ID.)" @Success 200 {object} SimpleMessage @Failure 503 {object} SimpleMessage @Router /test/tracing [get]
Types ¶
type SimpleMessage ¶ added in v0.2.1
type TbConnectionName ¶
type TbConnectionName struct {
ConnectionName string `json:"connectionName"`
}
Source Files