items

Documentation

Overview

Package items provides a series of HTTP handlers for managing items in a compatible database.

Index

• Constants
• Variables
• func ProvideService(ctx context.Context, logger logging.Logger, cfg *Config, ...) (types.ItemDataService, error)
• type Config
  • func (cfg *Config) ValidateWithContext(ctx context.Context) error
• type SearchIndex

Constants

const (
	// ItemIDURIParamKey is a standard string that we'll use to refer to item IDs with.
	ItemIDURIParamKey = "itemID"
)

Variables

var Providers = wire.NewSet(
	ProvideService,
)

Providers is our collection of what we provide to other services.

Functions

func ProvideService

func ProvideService(
	ctx context.Context,
	logger logging.Logger,
	cfg *Config,
	itemDataManager types.ItemDataManager,
	encoder encoding.ServerEncoderDecoder,
	searchIndexProvider search.IndexManagerProvider,
	routeParamManager routing.RouteParamManager,
	publisherProvider publishers.PublisherProvider,
) (types.ItemDataService, error)

ProvideService builds a new ItemsService.

Types

type Config

type Config struct {
	Logging              logging.Config `json:"logging" mapstructure:"logging" toml:"logging,omitempty"`
	PreWritesTopicName   string         `json:"pre_writes_topic_name" mapstructure:"pre_writes_topic_name" toml:"pre_writes_topic_name,omitempty"`
	PreUpdatesTopicName  string         `json:"pre_updates_topic_name" mapstructure:"pre_updates_topic_name" toml:"pre_updates_topic_name,omitempty"`
	PreArchivesTopicName string         `json:"pre_archives_topic_name" mapstructure:"pre_archives_topic_name" toml:"pre_archives_topic_name,omitempty"`
	SearchIndexPath      string         `json:"searchIndexPath" mapstructure:"search_index_path" toml:"search_index_path,omitempty"`
	// contains filtered or unexported fields
}

Config configures the service.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.

type SearchIndex

type SearchIndex search.IndexManager

SearchIndex is a type alias for dependency injection's sake.