jsonapi

type Attributes map[string]interface{}

type Data struct {
	Resource  *Resource
	Resources Resources
}

type DataTypeBits int

type Error struct {
	ID     string `json:"id,omitempty"`
	Status int    `json:"status,string,omitempty"`
	Code   string `json:"code,omitempty"`
	Title  string `json:"title,omitempty"`
	Detail string `json:"detail,omitempty"`
	Source Meta   `json:"source,omitempty"`
	Links  Links  `json:"links,omitempty"`
	Meta   Meta   `json:"meta,omitempty"`
}

type ErrorHandler func(ctx context.Context, rw http.ResponseWriter, req *http.Request) error

type Errors []Error

type Fieldsets map[string][]string

type Includes []string

type JSONAPI struct {
	Version string `json:"version,omitempty"`
	Meta    Meta   `json:"meta,omitempty"`
}

type Link linkFields

type Links map[string]Link

type Meta map[string]interface{}

type Middleware struct {
	// Includes is a list of relationship paths supported by the include
	// parameter. Use Any to accept all paths.
	Includes Includes

	// Sorts defines the supported sort fields. The expression fields defined
	// here will be copied into the request's sort fields so the expressions
	// will be available to the handler.
	Sorts Sorts

	// The maximum allowed page size and limit. If 0, then no limit is enforced.
	MaxPageSize, MaxPageLimit int

	// ClientIDs configures the validation check for client-generated IDs in the
	// request body. Possible values are Forbidden (the default), Optional, or
	// Required. Only applies to POST requests.
	ClientIDs Requirement

	// Type is the resource type that all resources in the request must have. If
	// this is an empty string, then all types are allowed.
	Type string

	// DataTypes is a bit field that represents the types that are allowed for
	// the request body data. Possible values are DataNull, DataSingle, and/or
	// DataArray. Use OR (`|`) to allow multiple types. The defaults are
	// DataSingle for POST and PATCH requests and DataNull for other methods.
	DataTypes DataTypeBits

	// Handler is the context handler that is called if the request is valid.
	Handler web.ContextHandler
}

type Page struct {
	Number int
	Size   int
	Offset int
	Limit  int
	Cursor string
}

type Relationship struct {
	Links Links `json:"links,omitempty"`
	Data  *Data `json:"data,omitempty"`
	Meta  Meta  `json:"meta,omitempty"`
}

type Relationships map[string]*Relationship

type Request struct {
	Data *Data `json:"data"`

	// Params contains the request query parameters.
	Params url.Values `json:"-"`

	// Includes is a list of requested relationship paths. nil means the client
	// did not specify a list.
	Includes Includes `json:"-"`

	// Fieldsets is the sparse fieldsets specified in the request.
	Fieldsets Fieldsets `json:"-"`

	// Sorts contains the sort fields specified in the request.
	Sorts Sorts `json:"-"`

	// Page contains pagination parameter values.
	Page Page `json:"-"`
}

type Requirement int

type Resource struct {
	ID            string        `json:"id"`
	Type          string        `json:"type"`
	Attributes    Attributes    `json:"attributes,omitempty"`
	Relationships Relationships `json:"relationships,omitempty"`
	Links         Links         `json:"links,omitempty"`
	Meta          Meta          `json:"meta,omitempty"`
}

type Resourcer interface {
	Resource() *Resource
}

type Resourcers interface {
	Resources() Resources
}

type Resources []*Resource

type Response struct {
	Status int `json:"-"`

	JSONAPI  *JSONAPI  `json:"jsonapi,omitempty"`
	Links    Links     `json:"links,omitempty"`
	Data     *Data     `json:"data,omitempty"`
	Included Resources `json:"included,omitempty"`
	Errors   []Error   `json:"errors,omitempty"`
	Meta     Meta      `json:"meta,omitempty"`

	// Fieldsets defines sparse fieldsets to be applied to all resources in the
	// response when the response is written.
	Fieldsets Fieldsets `json:"-"`
	// contains filtered or unexported fields
}

type Sort struct {
	// Name is the name of the sort field that is used in the sort parameter.
	Name string

	// Expr is the actual expression (or column name) that is prefixed with ASC
	// or DESC depending on the order for this sort field.
	Expr string

	// ExprAsc and ExprDesc are the actual expressions for ascending and
	// descending order for this sort field.
	ExprAsc, ExprDesc string

	// Desc is true if this field should be sorted in descending order.
	Desc bool
}

type Sorts []*Sort