api

package

v0.6.0 Latest Latest Go to latest Published: Jun 3, 2023 License: MPL-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	V0Prefix = "/api/v0/"

	// Debug
	GetP2pDebugInfoPath = V0Prefix + "debug/p2p_info"
	GetDebugLogPath     = V0Prefix + "debug/log"
)

This section is empty.

This section is empty.

type Error struct {
	Message string `json:"error"`
}

func ErrorMessage(message string) Error

func (e Error) Error() string

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler(conf *config.Config, p2p *p2p.P2p, logBuffer *ringbuffer.RingBuffer) *Handler

func (h *Handler) GetLog(c echo.Context) (err error)

@Tags Debug @Summary Get logs @Accept json @Produce plain @Success 200 {string} string "log text" @Router /debug/log [GET]

func (h *Handler) GetP2pDebugInfo(c echo.Context) (err error)

@Tags Debug @Summary Get p2p debug info @Accept json @Produce json @Success 200 {object} entity.P2pDebugInfo @Router /debug/p2p_info [GET]

func (h *Handler) SetupAPI() error

func (h *Handler) Shutdown(ctx context.Context) error