Add v1 descriptions to external template api
@@ -11,22 +11,22 @@ type Template struct {
kapi.ObjectMeta `json:"metadata,omitempty"`
// Required: Objects is an array of objects to include in this template
- Objects []runtime.RawExtension `json:"objects"`
+ Objects []runtime.RawExtension `json:"objects" description:"list of objects to include in the template"`
// Optional: Parameters is an array of Parameters used during the
// Template to Config transformation.
- Parameters []Parameter `json:"parameters,omitempty"`
+ Parameters []Parameter `json:"parameters,omitempty" description:"optional: list of parameters used during template to config transformation"`
// Optional: Labels is a set of labels that are applied to every
// object during the Template to Config transformation
- Labels map[string]string `json:"labels,omitempty"`
+ Labels map[string]string `json:"labels,omitempty" description:"optional: list of lables that are applied to every object during the template to config transformation"`
}
// TemplateList is a list of Template objects.
type TemplateList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
- Items []Template `json:"items"`
+ Items []Template `json:"items" description:"list of templates"`
}
// Parameter defines a name/value variable that is to be processed during
@@ -34,22 +34,22 @@ type TemplateList struct {
type Parameter struct {
// Required: Parameter name must be set and it can be referenced in Template
// Items using ${PARAMETER_NAME}
- Name string `json:"name"`
+ Name string `json:"name" description:"name of the parameter"`
// Optional: Parameter can have description
- Description string `json:"description,omitempty"`
+ Description string `json:"description,omitempty" description:"optional: describes the parameter"`
// Optional: Value holds the Parameter data. If specified, the generator
// will be ignored. The value replaces all occurrences of the Parameter
// ${Name} expression during the Template to Config transformation.
- Value string `json:"value,omitempty"`
+ Value string `json:"value,omitempty" description:"optional: holds the parameter data. if specified, the generator is ignored. the value replaces all occurrences of the parameter ${Name} expression during template to config transformation"`
// Optional: Generate specifies the generator to be used to generate
// random string from an input value specified by From field. The result
// string is stored into Value field. If empty, no generator is being
// used, leaving the result Value untouched.
- Generate string `json:"generate,omitempty"`
+ Generate string `json:"generate,omitempty" description:"optional: generate specifies the generator to be used to generate random string from an input value specified by the from field. the result string is stored in the value field. if not specified, the value field is untouched"`
// Optional: From is an input value for the generator.
- From string `json:"from,omitempty"`
+ From string `json:"from,omitempty" description:"input value for the generator"`
}
