clients

package
v1.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 13, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DatasetVersionTypeStatic defines the dataset version
	// type for static datasets.
	DatasetVersionTypeStatic = "static"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientList

type ClientList struct {
	DatasetAPI    datasetAPI.Clienter
	FilesAPI      filesAPI.Clienter
	TopicAPI      topicAPI.Clienter
	UploadService uploadService.Clienter
	Zebedee       ZebedeeClient
}

ClientList holds all the API clients used by the service.

type ZebedeeClient

type ZebedeeClient interface {
	ApproveCollection(ctx context.Context, authToken, collectionID string) error
	ApproveCollectionContent(ctx context.Context, authToken, collectionID, lang, pagePath string) error
	CompleteCollectionContent(ctx context.Context, authToken, collectionID, lang, pagePath string) error
	CreateCollection(ctx context.Context, authToken string, collection zebedee.Collection) (zebedee.Collection, error)
	DeleteCollection(ctx context.Context, userAuthToken, collectionID string) error
	DeleteCollectionContent(ctx context.Context, userAuthToken, collectionID, path string) error
	GetCollection(ctx context.Context, authToken, collectionID string) (zebedee.Collection, error)
	GetDataset(ctx context.Context, authToken, collectionID, lang, path string) (d zebedee.Dataset, err error)
	GetDatasetLandingPage(ctx context.Context, authToken, collectionID, lang, path string) (d zebedee.DatasetLandingPage, err error)
	GetFileSize(ctx context.Context, authToken, collectionID, lang, uri string) (f zebedee.FileSize, err error)
	GetPageData(ctx context.Context, authToken, collectionID, lang, path string) (m zebedee.PageData, err error)
	GetResourceStream(ctx context.Context, authToken, collectionID, lang, path string) (s io.ReadCloser, err error)
	PublishCollection(ctx context.Context, authToken, collectionID string) error
	SaveContentToCollection(ctx context.Context, authToken, collectionID, path string, content interface{}) error
}

ZebedeeClient is an interface defining the methods for the Zebedee (github.com/ONSdigital/zebedee) client.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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