api

package

v1.5.0 Latest Latest Go to latest Published: Sep 1, 2022 License: MIT Imports: 28 Imported by: 0

Documentation ¶

Index ¶

Constants
type API
- func New(_ context.Context, cfg *config.Config, r chi.Router, idc *identity.Client, ...) *API
- func (api *API) ParseRequest(body io.Reader, req interface{}) error
type DatasetJSONDimension
type DatasetJSONLinks
type Error
type GetFilterDimensionOptionsItem
type GetFilterDimensionOptionsResponse

Constants ¶

const (
	DefaultLimit  = 20
	DefaultOffset = 0
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

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

API provides a struct to wrap the api around

func New ¶

func New(_ context.Context, cfg *config.Config, r chi.Router, idc *identity.Client, rsp responder, g generator, d datastore, ds datasetAPIClient, c cantabularClient, p kafka.IProducer) *API

New creates and initialises a new API

func (*API) ParseRequest ¶

func (api *API) ParseRequest(body io.Reader, req interface{}) error

ParseRequest attemts to read unmarshal a request body into a request object, returning an appropriate error on failure. 'req' must be a pointer to a struct. ParseRequest will also attempt to call the request's Valid() function if it has one and will throw an error if it fails

type DatasetJSONDimension ¶ added in v1.2.0

type DatasetJSONDimension struct {
	DimensionName string       `json:"dimension_name"`
	Options       []model.Link `json:"options"`
}

type DatasetJSONLinks ¶ added in v1.2.0

type DatasetJSONLinks struct {
	DatasetMetadata model.Link `json:"dataset_metadata"`
	Self            model.Link `json:"self"`
	Version         model.Link `json:"version"`
}

type Error ¶

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

Error is the packages error type

func (Error) BadRequest ¶ added in v1.2.0

func (e Error) BadRequest() bool

BadRequest satisfies the errBadRequest interface

func (Error) Error ¶

func (e Error) Error() string

Error satisfies the standard library Go error interface

func (Error) LogData ¶

func (e Error) LogData() map[string]interface{}

LogData satisfies the dataLogger interface which is used to recover log data from an error

func (Error) Message ¶

func (e Error) Message() string

Message satisfies the messager interface which is used to specify a response to be sent to the caller in place of the error text for a given error. This is useful when you don't want sensitive information or implementation details being exposed to the caller which could be used to find exploits in our API

func (Error) NotFound ¶ added in v1.2.0

func (e Error) NotFound() bool

NotFound satisfies the errNotFound interface

func (Error) Unwrap ¶

func (e Error) Unwrap() error

Unwrap implements the standard library Go unwrapper interface

type GetFilterDimensionOptionsItem ¶ added in v1.2.0

type GetFilterDimensionOptionsItem struct {
	Option    string     `json:"option"`
	Self      model.Link `json:"self"`
	Filter    model.Link `json:"filter"`
	Dimension model.Link `json:"Dimension"`
}

type GetFilterDimensionOptionsResponse ¶ added in v1.2.0

type GetFilterDimensionOptionsResponse struct {
	Items []GetFilterDimensionOptionsItem `json:"items"`
	// contains filtered or unexported fields
}

getDimensionOptionsResponse is the response body for GET /filters/{id}/dimensions/{name}/options

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL