controller

Documentation

Index

• func GetHealth(c echo.Context) error
• func GetInfraInfo(c echo.Context) error
• func GetSoftwareInfo(c echo.Context) error
• type SimpleMsg

Functions

func GetHealth

func GetHealth(c echo.Context) error

GetHealth func is for checking Cicada server health. @Summary Check Cicada is alive @Description Check Cicada is alive @Tags [Admin] System management @Accept json @Produce json @Success 200 {object} SimpleMsg "Successfully get heath state." @Failure 500 {object} common.ErrorResponse "Failed to check health."

func GetInfraInfo

func GetInfraInfo(c echo.Context) error

GetInfraInfo godoc

@Summary		Get a list of integrated infra information
@Description	Get infra information.
@Tags			[Infra] Get infra info
@Accept			json
@Produce		json
@Success		200	{object}	infra.Infra	"Successfully get information of the infra."
@Failure		400	{object}	common.ErrorResponse	"Sent bad request."
@Failure		500	{object}	common.ErrorResponse	"Failed to get information of the infra."
@Router			/infra [get]

func GetSoftwareInfo

func GetSoftwareInfo(c echo.Context) error

GetSoftwareInfo godoc

@Summary		Get a list of Integrated Infra information
@Description	Get software information.
@Tags			[Software] Get software info
@Accept			json
@Produce		json
@Success		200	{object}	software.Software	"Successfully get information of software."
@Failure		400	{object}	common.ErrorResponse	"Sent bad request."
@Failure		500	{object}	common.ErrorResponse	"Failed to get information of software."
@Router			/software [get]

Types

type SimpleMsg

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