views

Documentation

Index

• Variables
• func ValidateDescribedByTView(result *DescribedByTView) (err error)
• func ValidateNavTView(result *NavTView) (err error)
• func ValidateParameterDefTView(result *ParameterDefTView) (err error)
• func ValidateParameterOptTView(result *ParameterOptTView) (err error)
• func ValidateParameterTView(result *ParameterTView) (err error)
• func ValidateRefTView(result *RefTView) (err error)
• func ValidateSelfTView(result *SelfTView) (err error)
• func ValidateServiceListItemView(result *ServiceListItemView) (err error)
• func ValidateServiceListRT(result *ServiceListRT) (err error)
• func ValidateServiceListRTView(result *ServiceListRTView) (err error)
• func ValidateServiceStatusRT(result *ServiceStatusRT) (err error)
• func ValidateServiceStatusRTView(result *ServiceStatusRTView) (err error)
• func ValidateServiceStatusRTViewTiny(result *ServiceStatusRTView) (err error)
• type DescribedByTView
• type NavTView
• type ParameterDefTView
• type ParameterOptTView
• type ParameterTView
• type RefTView
• type SelfTView
• type ServiceListItemView
• type ServiceListRT
• type ServiceListRTView
• type ServiceStatusRT
• type ServiceStatusRTView

Variables

var (
	// ServiceListRTMap is a map indexing the attribute names of ServiceListRT by
	// view name.
	ServiceListRTMap = map[string][]string{
		"default": {
			"services",
			"at-time",
			"links",
		},
	}
	// ServiceStatusRTMap is a map indexing the attribute names of ServiceStatusRT
	// by view name.
	ServiceStatusRTMap = map[string][]string{
		"default": {
			"id",
			"name",
			"description",
			"tags",
			"metadata",
			"parameters",
			"provider",
			"account",
			"links",
		},
		"tiny": {
			"name",
			"links",
		},
	}
)

Functions

func ValidateDescribedByTView

func ValidateDescribedByTView(result *DescribedByTView) (err error)

ValidateDescribedByTView runs the validations defined on DescribedByTView.

func ValidateNavTView

func ValidateNavTView(result *NavTView) (err error)

ValidateNavTView runs the validations defined on NavTView.

func ValidateParameterDefTView

func ValidateParameterDefTView(result *ParameterDefTView) (err error)

ValidateParameterDefTView runs the validations defined on ParameterDefTView.

func ValidateParameterOptTView

func ValidateParameterOptTView(result *ParameterOptTView) (err error)

ValidateParameterOptTView runs the validations defined on ParameterOptTView.

func ValidateParameterTView

func ValidateParameterTView(result *ParameterTView) (err error)

ValidateParameterTView runs the validations defined on ParameterTView.

func ValidateRefTView

func ValidateRefTView(result *RefTView) (err error)

ValidateRefTView runs the validations defined on RefTView.

func ValidateSelfTView

func ValidateSelfTView(result *SelfTView) (err error)

ValidateSelfTView runs the validations defined on SelfTView.

func ValidateServiceListItemView

func ValidateServiceListItemView(result *ServiceListItemView) (err error)

ValidateServiceListItemView runs the validations defined on ServiceListItemView.

func ValidateServiceListRT

func ValidateServiceListRT(result *ServiceListRT) (err error)

ValidateServiceListRT runs the validations defined on the viewed result type ServiceListRT.

func ValidateServiceListRTView

func ValidateServiceListRTView(result *ServiceListRTView) (err error)

ValidateServiceListRTView runs the validations defined on ServiceListRTView using the "default" view.

func ValidateServiceStatusRT

func ValidateServiceStatusRT(result *ServiceStatusRT) (err error)

ValidateServiceStatusRT runs the validations defined on the viewed result type ServiceStatusRT.

func ValidateServiceStatusRTView

func ValidateServiceStatusRTView(result *ServiceStatusRTView) (err error)

ValidateServiceStatusRTView runs the validations defined on ServiceStatusRTView using the "default" view.

func ValidateServiceStatusRTViewTiny

func ValidateServiceStatusRTViewTiny(result *ServiceStatusRTView) (err error)

ValidateServiceStatusRTViewTiny runs the validations defined on ServiceStatusRTView using the "tiny" view.

Types

type DescribedByTView

type DescribedByTView struct {
	Href *string
	Type *string
}

DescribedByTView is a type that runs validations on a projected type.

type NavTView

type NavTView struct {
	Self  *string
	First *string
	Next  *string
}

NavTView is a type that runs validations on a projected type.

type ParameterDefTView

type ParameterDefTView struct {
	Name        *string
	Label       *string
	Type        *string
	Description *string
	Unit        *string
	Constant    *bool
	Optional    *bool
	Default     *string
	Options     []*ParameterOptTView
	Unary       *bool
}

ParameterDefTView is a type that runs validations on a projected type.

type ParameterOptTView

type ParameterOptTView struct {
	Value       *string
	Description *string
}

ParameterOptTView is a type that runs validations on a projected type.

type ParameterTView

type ParameterTView struct {
	Name  *string
	Value *string
}

ParameterTView is a type that runs validations on a projected type.

type RefTView

type RefTView struct {
	ID    *string
	Links *SelfTView
}

RefTView is a type that runs validations on a projected type.

type SelfTView

type SelfTView struct {
	Self        *string
	DescribedBy *DescribedByTView
}

SelfTView is a type that runs validations on a projected type.

type ServiceListItemView

type ServiceListItemView struct {
	// Service ID
	ID *string
	// Optional customer provided name
	Name *string
	// Optional description of the service
	Description *string
	// Optional provider link
	Provider *RefTView
	Links    *SelfTView
}

ServiceListItemView is a type that runs validations on a projected type.

type ServiceListRT

type ServiceListRT struct {
	// Type to project
	Projected *ServiceListRTView
	// View to render
	View string
}

ServiceListRT is the viewed result type that is projected based on a view.

type ServiceListRTView

type ServiceListRTView struct {
	// Services
	Services []*ServiceListItemView
	// Time at which this list was valid
	AtTime *string
	// Navigation links
	Links *NavTView
}

ServiceListRTView is a type that runs validations on a projected type.

type ServiceStatusRT

type ServiceStatusRT struct {
	// Type to project
	Projected *ServiceStatusRTView
	// View to render
	View string
}

ServiceStatusRT is the viewed result type that is projected based on a view.

type ServiceStatusRTView

type ServiceStatusRTView struct {
	// Service ID
	ID *string
	// Provider provided ID. Needs to be a single string with punctuations allowed.
	// Might have been changed
	ProviderRef *string
	// More detailed description of the service
	Description *string
	// Service status
	Status *string
	// Optional provider provided meta tags
	Metadata []*ParameterTView
	// Reference to service provider
	Provider *RefTView
	// Reference to billable account
	Account *RefTView
	Links   *SelfTView
	// Optional provider provided name
	Name *string
	// Optional provider provided tags
	Tags []string
	// Service parameter definitions
	Parameters []*ParameterDefTView
}

ServiceStatusRTView is a type that runs validations on a projected type.