annotations

package

v1.5.1-staging-validat... Latest Latest Go to latest Published: Mar 25, 2024 License: MIT Imports: 18 Imported by: 0

Documentation ¶

Index ¶

Constants
Variables
func NewCanonicalAnnotationSorter(ann []interface{}) sort.Interface
type Augmenter
- func NewAugmenter(api concept.ReadAPI, log *logger.UPPLogger) *Augmenter
- func (a *Augmenter) AugmentAnnotations(ctx context.Context, canonicalAnnotations []interface{}) ([]interface{}, error)
type Canonicalizer
- func NewCanonicalizer(sorterFactory func(ann []interface{}) sort.Interface) *Canonicalizer
- func (c *Canonicalizer) Canonicalize(in []interface{}) []interface{}
type OriginSystemIDHeaderKey
type RW
- func NewRW(client *http.Client, endpoint string, log *logger.UPPLogger) RW
type SchemaVersionHeaderKey
type UPPAnnotationsAPI
- func NewUPPAnnotationsAPI(client *http.Client, endpoint string, username string, password string, ...) *UPPAnnotationsAPI
type UPPError
- func NewUPPError(msg string, status int, uppBody []byte) UPPError

Constants ¶

const (

	// NoAnnotationsMsg is error message used when there are no processed annotations.
	NoAnnotationsMsg = "No annotations found"
	// UPPBadRequestMsg is error message used when UPP annotations endpoint returns bad request.
	UPPBadRequestMsg = "UPP responded with a client error"
	// UPPNotFoundMsg is error message used when UPP annotations endpoint returns not found.
	UPPNotFoundMsg = "UPP responded with not found"
	// UPPServiceUnavailableMsg is error message used when UPP annotations endpoint returns http error code
	// different from bad request and not found
	UPPServiceUnavailableMsg = "Service unavailable"
)

View Source

const (
	DocumentHashHeader         = "Document-Hash"
	PreviousDocumentHashHeader = "Previous-Document-Hash"
	SchemaVersionHeader        = "X-Schema-Version"
	DefaultSchemaVersion       = "1"
)

View Source

const (
	OriginSystemIDHeader = "X-Origin-System-Id"
	PACOriginSystemID    = "http://cmdb.ft.com/systems/pac"
)

Variables ¶

View Source

var ErrGTGNotOK = errors.New("gtg returned a non-200 HTTP status")

View Source

var ErrUnexpectedStatusRead = errors.New("annotations RW returned an unexpected HTTP status code in read operation")

View Source

var ErrUnexpectedStatusWrite = errors.New("annotations RW returned an unexpected HTTP status code in write operation")

Functions ¶

func NewCanonicalAnnotationSorter ¶

func NewCanonicalAnnotationSorter(ann []interface{}) sort.Interface

Types ¶

type Augmenter ¶

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

func NewAugmenter ¶

func NewAugmenter(api concept.ReadAPI, log *logger.UPPLogger) *Augmenter

func (*Augmenter) AugmentAnnotations ¶

func (a *Augmenter) AugmentAnnotations(ctx context.Context, canonicalAnnotations []interface{}) ([]interface{}, error)

type Canonicalizer ¶

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

func NewCanonicalizer ¶

func NewCanonicalizer(sorterFactory func(ann []interface{}) sort.Interface) *Canonicalizer

func (*Canonicalizer) Canonicalize ¶

func (c *Canonicalizer) Canonicalize(in []interface{}) []interface{}

type OriginSystemIDHeaderKey ¶

type OriginSystemIDHeaderKey string

type RW ¶

type RW interface {
	Read(ctx context.Context, contentUUID string) (map[string]interface{}, string, bool, error)
	Write(ctx context.Context, contentUUID string, data map[string]interface{}, hash string) (string, error)
	Endpoint() string
	GTG() error
}

func NewRW ¶

func NewRW(client *http.Client, endpoint string, log *logger.UPPLogger) RW

type SchemaVersionHeaderKey ¶

type SchemaVersionHeaderKey string

type UPPAnnotationsAPI ¶

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

UPPAnnotationsAPI retrieves published annotations from UPP.

func NewUPPAnnotationsAPI ¶

func NewUPPAnnotationsAPI(client *http.Client, endpoint string, username string, password string, log *logger.UPPLogger) *UPPAnnotationsAPI

NewUPPAnnotationsAPI initializes UPPAnnotationsAPI by given http client, the url of the UPP public endpoint for getting published annotations and UPP API key.

func (*UPPAnnotationsAPI) Endpoint ¶

func (api *UPPAnnotationsAPI) Endpoint() string

Endpoint retrieves the template for UPP annotations endpoint

func (*UPPAnnotationsAPI) GTG ¶

func (api *UPPAnnotationsAPI) GTG() error

GTG is making call the UPP annotations endpoint for predefined synthetic content UUID and check that response is returned

func (*UPPAnnotationsAPI) GetAll ¶

func (api *UPPAnnotationsAPI) GetAll(ctx context.Context, contentUUID string) ([]interface{}, error)

GetAll retrieves the list of published annotations for given contentUUID. The returned list contains the annotations returned by UPP without filtering.

func (*UPPAnnotationsAPI) GetAllButV2 ¶

func (api *UPPAnnotationsAPI) GetAllButV2(ctx context.Context, contentUUID string) ([]interface{}, error)

GetAllButV2 retrieves the list of published annotations for given contentUUID but filtering v2 annotations.

type UPPError ¶

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

UPPError encapsulates error information for errors originating from calls to UPP annotations endpoint.

func NewUPPError ¶ added in v1.4.9

func NewUPPError(msg string, status int, uppBody []byte) UPPError

NewUPPError initializes UPPError

func (UPPError) Error ¶

func (ue UPPError) Error() string

Error returns the error message.

func (UPPError) Status ¶

func (ue UPPError) Status() int

Status returns the http status code returned by the call to the UPP annotations endpoint.

func (UPPError) UPPBody ¶

func (ue UPPError) UPPBody() []byte

UPPBody returns the http response body returned by the call to the UPP annotations endpoint.

Source Files ¶

View all Source files

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