annotations

package

v1.1.10 Latest Latest Go to latest Published: Jun 19, 2023 License: MIT Imports: 14 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/Financial-Times/annotations-publisher

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Annotation
type AnnotationsBody
type AnnotationsClient
- func NewAnnotationsClient(endpoint string, client *http.Client) (AnnotationsClient, error)
type Publisher
- func NewPublisher(originSystemID string, draftAnnotationsClient AnnotationsClient, ...) Publisher

Constants ¶

View Source

const (
	DocumentHashHeader         = "Document-Hash"
	PreviousDocumentHashHeader = "Previous-Document-Hash"
)

Variables ¶

View Source

var (
	// ErrInvalidAuthentication occurs when UPP responds with a 401
	ErrInvalidAuthentication = errors.New("publish authentication is invalid")
	ErrDraftNotFound         = errors.New("draft was not found")
	ErrServiceTimeout        = errors.New("downstream service timed out")
)

Functions ¶

This section is empty.

Types ¶

type Annotation ¶

type Annotation struct {
	Predicate  string `json:"predicate"`
	ConceptID  string `json:"id"`
	APIURL     string `json:"apiUrl,omitempty"`
	Type       string `json:"type,omitempty"`
	PrefLabel  string `json:"prefLabel,omitempty"`
	IsFTAuthor bool   `json:"isFTAuthor,omitempty"`
}

type AnnotationsBody ¶

type AnnotationsBody struct {
	Annotations []Annotation `json:"annotations"`
}

type AnnotationsClient ¶

type AnnotationsClient interface {
	health.ExternalService
	GetAnnotations(ctx context.Context, uuid string) (AnnotationsBody, string, error)
	SaveAnnotations(ctx context.Context, uuid string, hash string, data AnnotationsBody) (AnnotationsBody, string, error)
}

func NewAnnotationsClient ¶

func NewAnnotationsClient(endpoint string, client *http.Client) (AnnotationsClient, error)

type Publisher ¶

type Publisher interface {
	health.ExternalService
	Publish(ctx context.Context, uuid string, body map[string]interface{}) error
	PublishFromStore(ctx context.Context, uuid string) error
	SaveAndPublish(ctx context.Context, uuid string, hash string, body AnnotationsBody) error
}

Publisher provides an interface to publish annotations to UPP

func NewPublisher ¶

func NewPublisher(originSystemID string, draftAnnotationsClient AnnotationsClient, publishedAnnotationsClient AnnotationsClient, publishEndpoint string, publishAuth string, gtgEndpoint string, client *http.Client) Publisher

NewPublisher returns a new Publisher instance

Source Files ¶

View all Source files

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