common

type ConsulClient struct {
	*api.Client
}

type ThingIdentifier struct {
	Group string `json:"group,omitempty"`
	Type  string `json:"type,omitempty"`
	UID   UID    `json:"uid,omitempty"`
}

type ThingMetadata struct {
	UID UID `json:"uid,omitempty"`
	// human-readable name of the thing (can contain spaces etc. as it is not used for identification)
	Name       string `json:"name,omitempty"`
	Generation int64  `json:"generation,omitempty"`
	// reference to the direct parent (sub-) thing.
	// this is empty for root things.
	ParentRef         string    `json:"parentRef,omitempty"`
	CreationTimestamp time.Time `json:"creationTimestamp,omitempty"`
	UpdateTimestamp   time.Time `json:"updateTimestamp,omitempty"`
	// collections that this (sub) thing belongs to.
	// for sub-things this will be synced eventually with the collections of the root thing (eventual consistency)
	Collections []UID             `json:"collections,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

type TypeIdentifier struct {
	// a group is a domain name, e.g. herzog.fyi
	Group string `json:"id"`
	// the type of the thing, e.g. postcard.
	// should be short (often only one word) and not contain spaces or special characters besides _ and -
	Type string `json:"type"`
	// the schema version of the thing, e.g. 1.
	// the version is monotonically increasing and signals major changes to the type, possibly breaking backwards compatibility
	SchemaVersion int64 `json:"schemaVersion"`
}

type UID string