rest

Documentation

Index

• Constants
• Variables
• func New(baseURL url.URL, nex nexus.Nexus, auth authn.Authn, push push.PushNotifier) *api
• func NewProgressSender[T any](w http.ResponseWriter, r *http.Request) (*progressSender[T], bool)
• func ShareFrom(ctx context.Context) *shares.Share
• type API
• type APIRoot
• type CallIncidentParams
• type EntityFunc
• type FilterPagination
• type ID
• type ShareHandlerFunc
• type ShareHandlers
• type ShareRequestType
  • func (rt ShareRequestType) IsValid() bool
• type SharedItem

Constants

const DefaultPerPage = 20

const (
	PrefsMaxBytes = 8192 // 8k
)

Variables

var (
	ErrNoCall          = errors.New("no call specified")
	ErrMustBePlaintext = errors.New("content type must be text/plain")
	ErrMustBeJSON      = errors.New("content type must be application/json")
)

var (
	ErrMissingTGSys = errors.New("missing talkgroup ID and system ID")
	ErrTGIDMismatch = errors.New("url talkgroup ID and document talkgroup ID mismatch")
	ErrSysMismatch  = errors.New("url system ID and document system ID mismatch")
	ErrNoSuchSystem = tgstore.ErrNoSuchSystem
	ErrBadSystem    = errors.New("invalid system")
)

var (
	ErrBadAppName = errors.New("bad app name")
)

var (
	ErrBadShare = errors.New("bad share request type")
)

Functions

func New

func New(baseURL url.URL, nex nexus.Nexus, auth authn.Authn, push push.PushNotifier) *api

func NewProgressSender

func NewProgressSender[T any](w http.ResponseWriter, r *http.Request) (*progressSender[T], bool)

NewProgressSender creates and starts a progressSender. The bool return is whether the connection accepts SSE.

func ShareFrom

func ShareFrom(ctx context.Context) *shares.Share

Types

type API

type API interface {
	Subrouter() http.Handler
}

type APIRoot

type APIRoot interface {
	API
	ShareRouter() http.Handler
}

type CallIncidentParams

type CallIncidentParams struct {
	Add   jsontypes.UUIDs `json:"add"`
	Notes json.RawMessage `json:"notes"`

	Remove jsontypes.UUIDs `json:"remove"`
}

type EntityFunc

type EntityFunc func(ctx context.Context, id ID) (SharedItem, error)

type FilterPagination

type FilterPagination struct {
	tgstore.Pagination

	Filter *string `json:"filter"`
}

type ID

type ID any

type ShareHandlerFunc

type ShareHandlerFunc func(id ID, w http.ResponseWriter, r *http.Request)

type ShareHandlers

type ShareHandlers map[ShareRequestType]ShareHandlerFunc

type ShareRequestType

type ShareRequestType string

const (
	ShareRequestCall          ShareRequestType = "call"
	ShareRequestCallInfo      ShareRequestType = "callinfo"
	ShareRequestCallDL        ShareRequestType = "callDL"
	ShareRequestIncident      ShareRequestType = "incident"
	ShareRequestIncidentM3U   ShareRequestType = "m3u"
	ShareRequestIncidentCalls ShareRequestType = "calls"
	ShareRequestTalkgroups    ShareRequestType = "talkgroups"
)

func (ShareRequestType) IsValid

func (rt ShareRequestType) IsValid() bool

type SharedItem

type SharedItem interface {
	SetShareURL(baseURL url.URL, shareID string)
}