common

Documentation

Index

• Constants
• type AttributeSet
• type DataSet
• type ListOption
  • func WithPage(page int) ListOption
  • func WithSize(size int) ListOption
• type Meta
• type RelationshipSet

Constants

const (
	// PageParam is the name of the page query parameter.
	PageParam = "page"
	// SizeParam is the name fo the size query parameter.
	SizeParam = "size"
)

Types

type AttributeSet

type AttributeSet map[string]interface{}

AttributeSet represents set of attributes.

type DataSet

type DataSet struct {
	Type            string    `json:"type"`
	ID              uuid.UUID `json:"id"`
	AttributeSet    `json:"attributes"`
	RelationshipSet `json:"relationships"`
	Meta            `json:"meta"`
}

DataSet represents a set of data for an entity.

type ListOption

type ListOption func(*http.Request)

ListOption modifies a list request.

func WithPage

func WithPage(page int) ListOption

WithPage sets the page of entities included in the list response.

func WithSize

func WithSize(size int) ListOption

WithSize sets the maximum number of entities included in the list response.

type Meta

type Meta map[string]interface{}

Meta represents metadata.

type RelationshipSet

type RelationshipSet map[string]interface{}

RelationshipSet represents set of relationships.