api

package

v0.0.0-...-0cfb223 Latest Latest Go to latest Published: Jan 19, 2024 License: AGPL-3.0 Imports: 1 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

This section is empty.

View Source

var Version = ""

Version stores the version of the current build

This section is empty.

type Health struct {
	OK      bool     `json:"ok"`
	Service *Service `json:"service"`
}

Health represents the object of the health root endpoint

func GetHealth() *Health

GetHealth performs a self-check and returns the result

type Index struct {
	Version string `json:"version" bson:"version"`
}

Index represents the object of the API root endpoint

func GetIndex() (*Index, error)

GetIndex returns the data of the API root endpoint

type Service struct {
	Database health.Status `json:"database"`
}

Service holds all services with their respective status