api

package

v1.4.1 Latest Latest Go to latest Published: Jul 3, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ONSdigital/dp-cantabular-metadata-extractor-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func OverrideMetadataTable(dims []string, mt *cantabular.MetadataTableQuery) error
type CantMetaAPI
type CantabularMetadataExtractorAPI
- func Setup(_ context.Context, r *mux.Router, cfg *config.Config, c CantMetaAPI, ...) *CantabularMetadataExtractorAPI
- func (api *CantabularMetadataExtractorAPI) GetMetadata(ctx context.Context, datasetID, lang string) (*cantabular.MetadataQueryResult, error)
- func (api *CantabularMetadataExtractorAPI) GetMetadataTable(_ context.Context, req cantabular.MetadataTableQueryRequest) (*cantabular.MetadataTableQuery, []string, error)

Constants ¶

View Source

const (
	CantabularMetadataDatasetReadPermission string = "cantabularmetadatadataset:read"
)

Variables ¶

This section is empty.

Functions ¶

func OverrideMetadataTable ¶

func OverrideMetadataTable(dims []string, mt *cantabular.MetadataTableQuery) error

OverrideMetadataTable modifies the dimensions and results of the MetadataTableQuery to always use "ltla". This is the geocode used in the recipe and we need to ensure the result from the metadata server matches the recipe. This ensures also the following GetMetadataDataset uses "ltla".

Types ¶

type CantMetaAPI ¶ added in v1.1.0

type CantMetaAPI interface {
	MetadataDatasetQuery(ctx context.Context, req cantabular.MetadataDatasetQueryRequest) (*cantabular.MetadataDatasetQuery, error)
	MetadataTableQuery(ctx context.Context, req cantabular.MetadataTableQueryRequest) (*cantabular.MetadataTableQuery, error)
}

cantExtAPI

type CantabularMetadataExtractorAPI ¶

type CantabularMetadataExtractorAPI struct {
	Router      *mux.Router
	CantMetaAPI CantMetaAPI
	Cfg         *config.Config
	// contains filtered or unexported fields
}

func Setup ¶

func Setup(_ context.Context,
	r *mux.Router,
	cfg *config.Config,
	c CantMetaAPI,
	auth authorisation.Middleware) *CantabularMetadataExtractorAPI

Setup function sets up the api and returns an api

func (*CantabularMetadataExtractorAPI) GetMetadata ¶ added in v1.2.0

func (api *CantabularMetadataExtractorAPI) GetMetadata(ctx context.Context, datasetID, lang string) (*cantabular.MetadataQueryResult, error)

func (*CantabularMetadataExtractorAPI) GetMetadataTable ¶

func (api *CantabularMetadataExtractorAPI) GetMetadataTable(_ context.Context, req cantabular.MetadataTableQueryRequest) (*cantabular.MetadataTableQuery, []string, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock

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