api

Documentation

Index

• func ExtractQueryParameters(urlQuery url.Values, validDimensions []string) (map[string]string, error)
• func GetDimensionOffsetInHeaderRow(headerRow []string) (int, error)
• func GetListOfValidDimensionNames(dimensions []dataset.VersionDimension) []string
• type API
  • func Setup(ctx context.Context, r *mux.Router, cfg *config.Config, graphDB IGraph, ...) *API
  • func (*API) Close(ctx context.Context) error
• type IAuthHandler
• type IDatasetClient
• type IGraph

Functions

func ExtractQueryParameters

func ExtractQueryParameters(urlQuery url.Values, validDimensions []string) (map[string]string, error)

ExtractQueryParameters creates a map of query parameters (options) by dimension from the provided urlQuery if they exist in the validDimensions list

func GetDimensionOffsetInHeaderRow

func GetDimensionOffsetInHeaderRow(headerRow []string) (int, error)

GetDimensionOffsetInHeaderRow splits the first item of the provided headers by '_', and returns the second item as integer

func GetListOfValidDimensionNames

func GetListOfValidDimensionNames(dimensions []dataset.VersionDimension) []string

GetListOfValidDimensionNames iterates the provided dimensions and returns an array with their names

Types

type API

type API struct {
	Router *mux.Router
	// contains filtered or unexported fields
}

API provides a struct to wrap the api around

func Setup

func Setup(ctx context.Context, r *mux.Router, cfg *config.Config, graphDB IGraph, datasetClient IDatasetClient, permissions IAuthHandler) *API

Setup creates the API struct and its endpoints with corresponding handlers

func (*API) Close

func (*API) Close(ctx context.Context) error

Close is called during graceful shutdown to give the API an opportunity to perform any required disposal task

type IAuthHandler

type IAuthHandler interface {
	Require(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc
}

IAuthHandler represents the required methods from authorisation library by Observation API

type IDatasetClient

type IDatasetClient interface {
	GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (m dataset.Version, err error)
	Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m dataset.DatasetDetails, err error)
	Checker(ctx context.Context, check *healthcheck.CheckState) error
}

IDatasetClient represents the required methods from the Dataset Client required by Observation API

type IGraph

type IGraph interface {
	driver.Driver
	StreamCSVRows(ctx context.Context, instanceID, filterID string, filters *observation.DimensionFilters, limit *int) (observation.StreamRowReader, error)
}

IGraph defines the required methods from GraphDB required by Observation API