core

Documentation

Overview

Package core implements the configurable backend and tools around it

Index

• func CanonicalHeaderToPropertyName(header string) string
• func Plural(singular string) string
• func PropertyNameToCanonicalHeader(property string) string
• type Notifier
• type Operation
  • func (o *Operation) UnmarshalJSON(data []byte) error

Functions

func CanonicalHeaderToPropertyName

func CanonicalHeaderToPropertyName(header string) string

CanonicalHeaderToPropertyName converts canonical header names to kurbisio JSON property names. Example: "Content-Type" becomes "content_type".

func Plural

func Plural(singular string) string

Plural returns the plural form of the passed singular string.

This is the algorithm used to create idiomatic REST routes

func PropertyNameToCanonicalHeader

func PropertyNameToCanonicalHeader(property string) string

PropertyNameToCanonicalHeader converts kurbisio JSON property names to their canonical header representation. Example: "content_type" becomes "Content-Type".

Types

type Notifier

type Notifier interface {
	Notify(resource string, operation Operation, payload []byte)
}

Notifier is an interface to receive database notifications

type Operation

type Operation string

Operation represents a modifying backend storage operation, one of Create, Read, Update, Delete, List, Clear

const (
	OperationCreate Operation = "create"
	OperationRead   Operation = "read"
	OperationUpdate Operation = "update"
	OperationDelete Operation = "delete"
	OperationList   Operation = "list"
	OperationClear  Operation = "clear"

	OperationCompanionUploaded Operation = "companion_uploaded"
)

all supported database operations OperationCompanionUploaded is only applicable if the reosurce has companion file feature enabled

func (*Operation) UnmarshalJSON

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON is a custom JSON unmarshaller