api

Documentation

Overview

Package api handles the creation and configuration of all API resource routes.

Index

• Variables
• func Cors(next http.Handler) http.Handler
• func NewRouter(ds datastore.Store, tp auth.TokenProvider) http.Handler
• type Role
• type RoleGrant
• type ValidatablePayload

Variables

var (
	ErrInvalidPayload = errors.New("invalid payload")
)

Functions

func Cors

func Cors(next http.Handler) http.Handler

func NewRouter

func NewRouter(ds datastore.Store, tp auth.TokenProvider) http.Handler

NewRouter creates an API router based on the parameter datastore and token provider. It registers and configures all necessary routes.

Types

type Role

type Role string

Role is an identifier for a group of assigned grants.

type RoleGrant

type RoleGrant string

Role grant is an identifier for the right to perform an action.

type ValidatablePayload

type ValidatablePayload interface {
	Validate() error
}