api

Documentation

Overview

Package api provides the functionality of the Voyager client-facing HTTP API.

Index

• Constants
• type Options
• type Service
  • func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, ...) Service

Constants

const (
	InfinityPinHeader           = "Infinity-Pin"
	InfinityTagHeader           = "Infinity-Tag"
	InfinityEncryptHeader       = "Infinity-Encrypt"
	InfinityIndexDocumentHeader = "Infinity-Index-Document"
	InfinityErrorDocumentHeader = "Infinity-Error-Document"
	InfinityFeedIndexHeader     = "Infinity-Feed-Index"
	InfinityFeedIndexNextHeader = "Infinity-Feed-Index-Next"
)

const (
	// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
	TargetsRecoveryHeader = "infinity-recovery-targets"
)

Types

type Options

type Options struct {
	CORSAllowedOrigins []string
	GatewayMode        bool
	WsPingPeriod       time.Duration
}

type Service

type Service interface {
	http.Handler
	m.Collector
	io.Closer
}

Service is the API service interface.

func New

func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, pss pss.Interface, traversalService traversal.Service, feedFactory feeds.Factory, logger logging.Logger, tracer *tracing.Tracer, o Options) Service

New will create a and initialize a new API service.