api

Documentation

Overview

Package api contains the api used by scribe

Index

• Constants
• func InitDB(ctx context.Context, database string, path string) (db.EventDB, error)
• func Start(ctx context.Context, cfg Config) error
• type Config

Constants

const HealthCheck string = "/health-check"

HealthCheck is the health check endpoint.

Functions

func InitDB

func InitDB(ctx context.Context, database string, path string) (db.EventDB, error)

InitDB initializes a database given a database type and path.

func Start

func Start(ctx context.Context, cfg Config) error

Start starts the api server.

Types

type Config

type Config struct {
	// HTTPPort is the http port for the api
	HTTPPort uint16
	// Database is the database type
	// TODO: should be enum
	Database string
	// Path is the path to the database or db connection
	// TODO: should be renamed
	Path string
	// GRPCPort is the path to the grpc service
	GRPCPort uint16
}

Config contains the config for the api.