common

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package common is to handle REST API for common funcitonalities

Package common is to handle REST API for common funcitonalities

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetReadyz added in v0.2.2

func GetReadyz(c echo.Context) error

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 "Unique request ID (auto-generated if not provided). Used for tracking request status and correlating logs." @Success 200 {object} SimpleMessage @Failure 503 {object} SimpleMessage @Router /readyz [get]

func Send

func Send(c echo.Context, httpCode int, json interface{}) error

func SendExistence

func SendExistence(c echo.Context, httpCode int, existence bool) error

func SendMessage

func SendMessage(c echo.Context, httpCode int, msg string) error

func Validate

func Validate(c echo.Context, params []string) error

Types

type Existence

type Existence struct {
	Exists bool `json:"exists"`
}

type SimpleMessage added in v0.2.1

type SimpleMessage struct {
	common.SimpleMsg
}

type Status

type Status struct {
	Message string `json:"message"`
}

type TbConnectionName

type TbConnectionName struct {
	ConnectionName string `json:"connectionName"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL