metadata

Documentation

Overview

Package metadata provides label constants used for resource identification and information sharing. Below is an incomplete list of resources we may take care of.

message
timeline
update
user

The above resources have different properties. It might be necessary to expose different pieces of information throughout the lifecycle of the resources when interacting with them.

id        unix timestamp normalized to UTC timezone
status    state change information e.g. "updated"

Index

• Constants
• func Contains(all map[string]string, sub map[string]string) bool

Constants

const (
	InviteCode   = "invite.venturemark.co/code"
	InviteID     = "invite.venturemark.co/id"
	InviteStatus = "invite.venturemark.co/status"
)

const (
	MessageID     = "message.venturemark.co/id"
	MessageStatus = "message.venturemark.co/status"
)

const (
	ResourceKind       = "resource.venturemark.co/kind"
	ResourceVisibility = "resource.venturemark.co/visibility"
)

const (
	RoleID     = "role.venturemark.co/id"
	RoleKind   = "role.venturemark.co/kind"
	RoleStatus = "role.venturemark.co/status"
)

const (
	SubjectEmail = "subject.venturemark.co/email"
	SubjectID    = "subject.venturemark.co/id"
)

const (
	TaskAction   = "task.venturemark.co/action"
	TaskAudience = "task.venturemark.co/audience"
	TaskInterval = "task.venturemark.co/interval"
	TaskResource = "task.venturemark.co/resource"
)

const (
	TimelineID         = "timeline.venturemark.co/id"
	TimelineLastUpdate = "timeline.venturemark.co/last-update"
	TimelineStatus     = "timeline.venturemark.co/status"
)

const (
	UpdateID     = "update.venturemark.co/id"
	UpdateFormat = "update.venturemark.co/format"
	UpdateStatus = "update.venturemark.co/status"
)

const (
	UserID             = "user.venturemark.co/id"
	UserPrepopulate    = "user.venturemark.co/prepopulate"
	UserStatus         = "user.venturemark.co/status"
	UserSurveyResponse = "user.venturemark.co/surveyResponse"
)

const (
	VentureID     = "venture.venturemark.co/id"
	VentureStatus = "venture.venturemark.co/status"
)

const (
	ClaimID = "claim.venturemark.co/id"
)

const (
	// PermissionModel indicates which role kinds to prefer for resource role
	// creation. E.g. defining the visibility of a resource as "private" can be
	// persisted using this metadata key, so that roles can be created according
	// to the permission model.
	PermissionModel = "permission.venturemark.co/model"
)

Functions

func Contains

func Contains(all map[string]string, sub map[string]string) bool