annotations

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

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

Variables

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")
)

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