api

type Parameter struct {
	// Required: Name uniquely identifies the Parameter. A TemplateProcessor
	// searches given Template for all occurances of the Parameter name, ie.
	// ${PARAM_NAME}, and replaces it with it's corresponding Parameter value.
	Name string `json:"name" yaml:"name"`

	// Optional: Description describes the Parameter.
	Description string `json:"description" yaml:"description"`

	// Required: Type defines the type of the Parameter value.
	Type string `json:"type" yaml:"type"`

	// Optional: Expression generates new Value data using the
	// GeneratorExpressionValue expression.
	// TODO: Support more Generator types.
	Expression string `json:"expression,omitempty" yaml:"expression,omitempty"`

	// Optional: Value holds the Parameter data. The data replaces all occurances
	// of the Parameter name during the Template to Config transformation.
	// TODO: Change this to runtime.Object and support more types than just string.
	Value string `json:"value,omitempty" yaml:"value,omitempty"`
}

type Template struct {
	kubeapi.JSONBase `json:",inline" yaml:",inline"`

	// Required: Name identifies the Template.
	Name string `json:"name" yaml:"name"`

	// Optional: Description describes the Template.
	Description string `json:"description" yaml:"description"`

	// Required: Items is an array of Kubernetes resources of Service,
	// Pod and/or ReplicationController kind.
	// TODO: Handle unregistered types. Define custom []runtime.Object
	//       type and its unmarshaller instead of []runtime.Object.
	Items []runtime.EmbeddedObject `json:"items" yaml:"items"`

	// Optional: Parameters is an array of Parameters used during the
	// Template to Config transformation.
	Parameters []Parameter `json:"parameters,omitempty" yaml:"parameters,omitempty"`
}