requests

Documentation

Index

• type Content
• type Env
• type ItemMap
• type Node
• type Nodes
• type Repo
• type URIs
• type Update

Types

type Content

type Content struct {
	Env            *Env             `json:"env"`
	URI            string           `json:"URI"`
	Nodes          map[string]*Node `json:"nodes"`
	DataFields     []string         `json:"dataFields"`
	PathDataFields []string         `json:"pathDataFields"`
}

Content - the standard request to contentserver

type Env

type Env struct {
	// when resolving conten these are processed in their order
	Dimensions []string `json:"dimensions"`
	// who is it for
	Groups []string `json:"groups"`
}

Env - abstract your server state

type ItemMap

type ItemMap struct {
	ID         string   `json:"id"`
	DataFields []string `json:"dataFields"`
}

ItemMap - map of items

type Node

type Node struct {
	// this one should be obvious
	ID string `json:"id"`
	// from which dimension
	Dimension string `json:"dimension"`
	// allowed access groups
	Groups []string `json:"groups"`
	// what do you want to see in your navigations, folders, images or unicorns
	MimeTypes []string `json:"mimeTypes"`
	// expand the navigation tree or just the path to the resolved content
	Expand bool `json:"expand"`
	// Expose hidden nodes
	ExposeHiddenNodes bool `json:"exposeHiddenNodes,omitempty"`
	// filter with these
	DataFields []string `json:"dataFields"`
}

Node - an abstract node request, use this one to request navigations

type Nodes

type Nodes struct {
	// map[dimension]*node
	Nodes map[string]*Node `json:"nodes"`
	Env   *Env             `json:"env"`
}

Nodes - which nodes in which dimensions

type Repo

type Repo struct{}

Repo - query repo

type URIs

type URIs struct {
	IDs       []string `json:"ids"`
	Dimension string   `json:"dimension"`
}

URIs - request multiple URIs for a dimension use this resolve uris for links in a document

type Update

type Update struct{}

Update - request an update