Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetHealth ¶
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 ¶
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 ¶
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 ¶
Click to show internal directories.
Click to hide internal directories.