rest

Documentation

Index

• type Input
• type REST

Types

type Input

type Input struct {
	// OffsetID is the minimal ID for the request. We assume that ID is
	// a sequential, unique and indexed for all the queries.
	// In case of `/pages` resource we use Item ID for this
	// parameter.
	OffsetID int `json:"offsetId" query:"offset_id"`

	// Limit is the value to calculate maximal ID for the request.
	// For example, if OffsetID is 10 and Limit is 1000, then maximal ID
	// would be 1010.
	// If Limit parameter is larger than 50000, it will be truncated to
	// 50000.
	Limit int `json:"limit" query:"limit"`

	// DataSources provides list of Data Source IDs to filter verified names
	// result by these IDs. This filter is ignored by all resources except
	// `/names` resource.
	DataSources []int `json:"dataSources" query:"data_sources"`
}

Input for RESTful API

type REST

type REST interface {
	// Run creates a service to BHLindex running on.
	Run(port int)

	// Info returns links to documentation and GitHub
	Info() func(echo.Context) error

	// Ping checks connection to the RESTful server.
	Ping() func(echo.Context) error

	// Version returns bhlindex's version.
	Version() func(echo.Context) error

	// Items returns BHL's items metadata. An item can be a book, a journal,
	// a bulletin etc.
	Items() func(echo.Context) error

	// Pages returns metadata for pages from BHL's items.
	Pages() func(echo.Context) error

	// Names returns a batch of verified names from the index.
	Names() func(echo.Context) error

	// NamesLastID returns the last NameID from verified_names.
	NamesLastID() func(echo.Context) error

	// Occurrences returns a batch of names occurrences and their metadata.
	Occurrences() func(echo.Context) error
}

REST interface describes functionality of RESTful API for BHL's scientific names index.