api

Documentation

Index

• Constants
• Variables
• type API
• type AuthHandler
• type DatasetAPI
  • func Setup(ctx context.Context, cfg *config.Configuration, router *mux.Router, ...) *DatasetAPI
• type DownloadsGenerator
• type PublishCheck
  • func (d *PublishCheck) Check(handle func(http.ResponseWriter, *http.Request), action string) http.HandlerFunc
• type VersionDetails

Constants

const IsBasedOn = "is_based_on"

Variables

var MaxIDs = func() int {
	return maxIDs
}

MaxIDs returns the maximum number of IDs acceptable in a list

Types

type API

type API interface {
	CreateDatasetAPI(string, *mux.Router, store.DataStore) *DatasetAPI
}

API provides an interface for the routes

type AuthHandler

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

AuthHandler provides authorisation checks on requests

type DatasetAPI

type DatasetAPI struct {
	Router *mux.Router

	EnablePrePublishView bool

	MaxRequestOptions int
	// contains filtered or unexported fields
}

DatasetAPI manages importing filters against a dataset

func Setup

func Setup(ctx context.Context, cfg *config.Configuration, router *mux.Router, dataStore store.DataStore, urlBuilder *url.Builder, downloadGenerators map[models.DatasetType]DownloadsGenerator, datasetPermissions, permissions AuthHandler) *DatasetAPI

Setup creates a new Dataset API instance and register the API routes based on the application configuration.

type DownloadsGenerator

type DownloadsGenerator interface {
	Generate(ctx context.Context, datasetID, instanceID, edition, version string) error
}

DownloadsGenerator pre generates full file downloads for the specified dataset/edition/version

type PublishCheck

type PublishCheck struct {
	Datastore store.Storer
}

PublishCheck Checks if an version has been published

func (*PublishCheck) Check

func (d *PublishCheck) Check(handle func(http.ResponseWriter, *http.Request), action string) http.HandlerFunc

Check wraps a HTTP handle. Checks that the state is not published TODO: Refactor this to reduce the complexity

type VersionDetails

type VersionDetails struct {
	// contains filtered or unexported fields
}

VersionDetails contains the details that uniquely identify a version resource