api

package

v1.0.10-0...-7349ede Latest Latest Go to latest Published: Sep 20, 2023 License: MIT Imports: 22 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 InvalidParamsMessage = "Invalid query or path parameters"

This section is empty.

func JetDropToAPI(jetDrop models.JetDrop, prevJetDrops, nextJetDrops []server.NextPrevJetDrop) server.JetDrop

func NullableString(s string) *string

func PulseToAPI(pulse models.Pulse) server.Pulse

func RecordToAPI(record models.Record) server.Record

type PromHTTPLoggerAdapter struct {
	log.Logger
}

func (o PromHTTPLoggerAdapter) Println(v ...interface{})

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

func NewRouter() *Router

func (r *Router) Start(ctx context.Context) error

func (r *Router) Stop(ctx context.Context) error

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

func NewServer(ctx context.Context, storage interfaces.StorageAPIFetcher, config configuration.API) *Server

NewServer returns instance of API server

func (s *Server) JetDropByID(ctx echo.Context, jetDropID server.JetDropIdPath) error

func (s *Server) JetDropRecords(ctx echo.Context, jetDropID server.JetDropIdPath, params server.JetDropRecordsParams) error

func (s *Server) JetDropsByJetID(ctx echo.Context, jetID server.JetIdPath, params server.JetDropsByJetIDParams) error

func (s *Server) JetDropsByPulseNumber(ctx echo.Context, pulseNumber server.PulseNumberPath, params server.JetDropsByPulseNumberParams) error

func (s *Server) ObjectLifeline(ctx echo.Context, objectReference server.ObjectReferencePath, params server.ObjectLifelineParams) error

func (s *Server) Pulse(ctx echo.Context, pulseNumber server.PulseNumberPath) error

func (s *Server) Pulses(ctx echo.Context, params server.PulsesParams) error

func (s *Server) Search(ctx echo.Context, params server.SearchParams) error