@@ -17,10 +17,10 @@ type Build struct {

 	kapi.ObjectMeta `json:"metadata,omitempty"`

 	// Spec is all the inputs used to execute the build.

-	Spec BuildSpec `json:"spec,omitempty"`

+	Spec BuildSpec `json:"spec,omitempty" description:"specification of the desired behavior for a build"`

 	// Status is the current status of the build.

-	Status BuildStatus `json:"status,omitempty"`

+	Status BuildStatus `json:"status,omitempty" description:"most recently observed status of a build as populated by the system"`

 }

 // BuildSpec encapsulates all the inputs necessary to represent a build.

@@ -28,20 +28,20 @@ type BuildSpec struct {

 	// ServiceAccount is the name of the ServiceAccount to use to run the pod

 	// created by this build.

 	// The pod will be allowed to use secrets referenced by the ServiceAccount

-	ServiceAccount string `json:"serviceAccount,omitempty"`

+	ServiceAccount string `json:"serviceAccount,omitempty" description:"the name of the service account to use to run pods created by the build, pod will be allowed to use secrets referenced by the service account"`

 	// Source describes the SCM in use.

-	Source BuildSource `json:"source,omitempty"`

+	Source BuildSource `json:"source,omitempty" description:"describes the source control management system in use"`

 	// Revision is the information from the source for a specific repo snapshot.

 	// This is optional.

-	Revision *SourceRevision `json:"revision,omitempty"`

+	Revision *SourceRevision `json:"revision,omitempty" description:"specific revision in the source repository"`

 	// Strategy defines how to perform a build.

-	Strategy BuildStrategy `json:"strategy"`

+	Strategy BuildStrategy `json:"strategy" description:"defines how to perform a build"`

 	// Output describes the Docker image the Strategy should produce.

-	Output BuildOutput `json:"output,omitempty"`

+	Output BuildOutput `json:"output,omitempty" description:"describes the output of a build that a strategy should produce"`

 	// Compute resource requirements to execute the build

 	Resources kapi.ResourceRequirements `json:"resources,omitempty" description:"the desired compute resources the build should have"`

@@ -50,30 +50,30 @@ type BuildSpec struct {

 // BuildStatus contains the status of a build

 type BuildStatus struct {

 	// Phase is the point in the build lifecycle.

-	Phase BuildPhase `json:"phase"`

+	Phase BuildPhase `json:"phase" description:"observed point in the build lifecycle"`

 	// Cancelled describes if a cancelling event was triggered for the build.

-	Cancelled bool `json:"cancelled,omitempty"`

+	Cancelled bool `json:"cancelled,omitempty" description:"describes if a canceling event was triggered for the build"`

-	// A human readable message indicating details about why the build has this status

-	Message string `json:"message,omitempty"`

+	// A human-readable message indicating details about why the build has this status

+	Message string `json:"message,omitempty" description:"human-readable message indicating details about why the build has this status"`

 	// StartTimestamp is a timestamp representing the server time when this Build started

 	// running in a Pod.

 	// It is represented in RFC3339 form and is in UTC.

-	StartTimestamp *util.Time `json:"startTimestamp,omitempty"`

+	StartTimestamp *util.Time `json:"startTimestamp,omitempty" description:"server time when this build started running in a pod"`

 	// CompletionTimestamp is a timestamp representing the server time when this Build was

 	// finished, whether that build failed or succeeded.  It reflects the time at which

 	// the Pod running the Build terminated.

 	// It is represented in RFC3339 form and is in UTC.

-	CompletionTimestamp *util.Time `json:"completionTimestamp,omitempty"`

+	CompletionTimestamp *util.Time `json:"completionTimestamp,omitempty" description:"server time when the pod running this build stopped running"`

 	// Duration contains time.Duration object describing build time.

-	Duration time.Duration `json:"duration,omitempty"`

+	Duration time.Duration `json:"duration,omitempty" description:"amount of time the build has been running"`

 	// Config is an ObjectReference to the BuildConfig this Build is based on.

-	Config *kapi.ObjectReference `json:"config,omitempty"`

+	Config *kapi.ObjectReference `json:"config,omitempty" description:"reference to build config from which this build was derived"`

 }

 // BuildPhase represents the status of a build at a point in time.

@@ -115,13 +115,13 @@ const (

 // BuildSource is the SCM used for the build

 type BuildSource struct {

-	Type BuildSourceType `json:"type,omitempty"`

-	Git  *GitBuildSource `json:"git,omitempty"`

+	Type BuildSourceType `json:"type,omitempty" description:"type of source control management system"`

+	Git  *GitBuildSource `json:"git,omitempty" description:"optional information about git build source"`

 	// Specify the sub-directory where the source code for the application exists.

 	// This allows to have buildable sources in directory other than root of

 	// repository.

-	ContextDir string `json:"contextDir,omitempty"`

+	ContextDir string `json:"contextDir,omitempty" description:"specifies sub-directory where the source code for the application exists, allows for sources to be built from a directory other than the root of a repository"`

 	// SourceSecret is the name of a Secret that would be used for setting

 	// up the authentication for cloning private repository.

@@ -133,54 +133,54 @@ type BuildSource struct {

 // SourceRevision is the revision or commit information from the source for the build

 type SourceRevision struct {

-	Type BuildSourceType    `json:"type,omitempty"`

-	Git  *GitSourceRevision `json:"git,omitempty"`

+	Type BuildSourceType    `json:"type,omitempty" description:"type of the build source"`

+	Git  *GitSourceRevision `json:"git,omitempty" description:"information about git-based build source"`

 }

 // GitSourceRevision is the commit information from a git source for a build

 type GitSourceRevision struct {

 	// Commit is the commit hash identifying a specific commit

-	Commit string `json:"commit,omitempty"`

+	Commit string `json:"commit,omitempty" description:"hash identifying a specific commit"`

 	// Author is the author of a specific commit

-	Author SourceControlUser `json:"author,omitempty"`

+	Author SourceControlUser `json:"author,omitempty" description:"author of a specific commit"`

 	// Committer is the committer of a specific commit

-	Committer SourceControlUser `json:"committer,omitempty"`

+	Committer SourceControlUser `json:"committer,omitempty" description:"committer of a specific commit"`

 	// Message is the description of a specific commit

-	Message string `json:"message,omitempty"`

+	Message string `json:"message,omitempty" description:"description of a specific commit"`

 }

 // GitBuildSource defines the parameters of a Git SCM

 type GitBuildSource struct {

 	// URI points to the source that will be built. The structure of the source

 	// will depend on the type of build to run

-	URI string `json:"uri,omitempty"`

+	URI string `json:"uri,omitempty" description:"points to the source that will be built, structure of the source will depend on the type of build to run"`

 	// Ref is the branch/tag/ref to build.

-	Ref string `json:"ref,omitempty"`

+	Ref string `json:"ref,omitempty" description:"identifies the branch/tag/ref to build"`

 }

 // SourceControlUser defines the identity of a user of source control

 type SourceControlUser struct {

-	Name  string `json:"name,omitempty"`

-	Email string `json:"email,omitempty"`

+	Name  string `json:"name,omitempty" description:"name of the source control user"`

+	Email string `json:"email,omitempty" description:"e-mail of the source control user"`

 }

 // BuildStrategy contains the details of how to perform a build.

 type BuildStrategy struct {

 	// Type is the kind of build strategy.

-	Type BuildStrategyType `json:"type"`

+	Type BuildStrategyType `json:"type" description:"identifies the type of build strategy"`

 	// DockerStrategy holds the parameters to the Docker build strategy.

-	DockerStrategy *DockerBuildStrategy `json:"dockerStrategy,omitempty"`

+	DockerStrategy *DockerBuildStrategy `json:"dockerStrategy,omitempty" description:"holds parameters for the Docker build strategy"`

 	// SourceStrategy holds the parameters to the Source build strategy.

-	SourceStrategy *SourceBuildStrategy `json:"sourceStrategy,omitempty"`

+	SourceStrategy *SourceBuildStrategy `json:"sourceStrategy,omitempty" description:"holds parameters to the Source build strategy"`

 	// CustomStrategy holds the parameters to the Custom build strategy

-	CustomStrategy *CustomBuildStrategy `json:"customStrategy,omitempty"`

+	CustomStrategy *CustomBuildStrategy `json:"customStrategy,omitempty" description:"holds parameters to the Custom build strategy"`

 }

 // BuildStrategyType describes a particular way of performing a build.

@@ -203,7 +203,7 @@ const (

 type CustomBuildStrategy struct {

 	// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which

 	// the docker image should be pulled

-	From *kapi.ObjectReference `json:"from,omitempty"`

+	From *kapi.ObjectReference `json:"from,omitempty" description:"reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled"`

 	// PullSecret is the name of a Secret that would be used for setting up

 	// the authentication for pulling the Docker images from the private Docker

@@ -211,12 +211,12 @@ type CustomBuildStrategy struct {

 	PullSecret *kapi.LocalObjectReference `json:"pullSecret,omitempty" description:"supported type: dockercfg"`

 	// Additional environment variables you want to pass into a builder container

-	Env []kapi.EnvVar `json:"env,omitempty"`

+	Env []kapi.EnvVar `json:"env,omitempty" description:"additional environment variables you want to pass into a builder container"`

 	// ExposeDockerSocket will allow running Docker commands (and build Docker images) from

 	// inside the Docker container.

 	// TODO: Allow admins to enforce 'false' for this option

-	ExposeDockerSocket bool `json:"exposeDockerSocket,omitempty"`

+	ExposeDockerSocket bool `json:"exposeDockerSocket,omitempty" description:"allow running Docker commands (and build Docker images) from inside the container"`

 }

 // DockerBuildStrategy defines input parameters specific to Docker build.

@@ -224,7 +224,7 @@ type DockerBuildStrategy struct {

 	// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which

 	// the docker image should be pulled

 	// the resulting image will be used in the FROM line of the Dockerfile for this build.

-	From *kapi.ObjectReference `json:"from,omitempty"`

+	From *kapi.ObjectReference `json:"from,omitempty" description:"reference to image stream, image stream tag, or image stream image from which docker image should be pulled, resulting image will be used in the FROM line for the Dockerfile for this build"`

 	// PullSecret is the name of a Secret that would be used for setting up

 	// the authentication for pulling the Docker images from the private Docker

@@ -233,14 +233,14 @@ type DockerBuildStrategy struct {

 	// NoCache if set to true indicates that the docker build must be executed with the

 	// --no-cache=true flag

-	NoCache bool `json:"noCache,omitempty"`

+	NoCache bool `json:"noCache,omitempty" description:"if true, indicates that the Docker build must be executed with the --no-cache=true flag"`

 }

 // SourceBuildStrategy defines input parameters specific to an Source build.

 type SourceBuildStrategy struct {

 	// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which

 	// the docker image should be pulled

-	From *kapi.ObjectReference `json:"from,omitempty"`

+	From *kapi.ObjectReference `json:"from,omitempty" description:"reference to an image stream, image stream tag, or image stream image from which the Docker image should be pulled"`

 	// PullSecret is the name of a Secret that would be used for setting up

 	// the authentication for pulling the Docker images from the private Docker

@@ -248,13 +248,13 @@ type SourceBuildStrategy struct {

 	PullSecret *kapi.LocalObjectReference `json:"pullSecret,omitempty" description:"supported type: dockercfg"`

 	// Additional environment variables you want to pass into a builder container

-	Env []kapi.EnvVar `json:"env,omitempty"`

+	Env []kapi.EnvVar `json:"env,omitempty" description:"additional environment variables you want to pass into a builder container"`

 	// Scripts is the location of Source scripts

-	Scripts string `json:"scripts,omitempty"`

+	Scripts string `json:"scripts,omitempty" description:"location of the source scripts"`

 	// Incremental flag forces the Source build to do incremental builds if true.

-	Incremental bool `json:"incremental,omitempty"`

+	Incremental bool `json:"incremental,omitempty" description:"forces the source build to do incremental builds if true"`

 }

 // BuildOutput is input to a build strategy and describes the Docker image that the strategy

@@ -264,7 +264,7 @@ type BuildOutput struct {

 	// may be empty, in which case the ImageStream will be looked for in the namespace of

 	// the build. Kind must be one of 'ImageStreamImage', 'ImageStreamTag' or 'DockerImage'.

 	// This value will be used to look up a Docker image repository to push to.

-	To *kapi.ObjectReference `json:"to,omitempty"`

+	To *kapi.ObjectReference `json:"to,omitempty" description:"The optional image stream to push the output of this build.  The namespace may be empty, in which case, the image stream will be looked up based on the namespace of the build."`

 	// PushSecret is the name of a Secret that would be used for setting

 	// up the authentication for executing the Docker push to authentication

@@ -283,52 +283,52 @@ type BuildConfig struct {

 	// Spec holds all the input necessary to produce a new build, and the conditions when

 	// to trigger them.

-	Spec BuildConfigSpec `json:"spec"`

+	Spec BuildConfigSpec `json:"spec" description:"holds all the input necessary to produce a new build, and the conditions when to trigger them"`

 	// Status holds any relevant information about a build config

-	Status BuildConfigStatus `json:"status"`

+	Status BuildConfigStatus `json:"status" description:"holds any relevant information about a build config derived by the system"`

 }

 // BuildConfigSpec describes when and how builds are created

 type BuildConfigSpec struct {

 	// Triggers determine how new Builds can be launched from a BuildConfig. If no triggers

 	// are defined, a new build can only occur as a result of an explicit client build creation.

-	Triggers []BuildTriggerPolicy `json:"triggers"`

+	Triggers []BuildTriggerPolicy `json:"triggers" description:"determines how new builds can be launched from a build config.  if no triggers are defined, a new build can only occur as a result of an explicit client build creation."`

-	BuildSpec `json:",inline"`

+	BuildSpec `json:",inline" description:"the desired build specification"`

 }

 // BuildConfigStatus contains current state of the build config object.

 type BuildConfigStatus struct {

 	// LastVersion is used to inform about number of last triggered build.

-	LastVersion int `json:"lastVersion"`

+	LastVersion int `json:"lastVersion" description:"used to inform about number of last triggered build"`

 }

 // WebHookTrigger is a trigger that gets invoked using a webhook type of post

 type WebHookTrigger struct {

 	// Secret used to validate requests.

-	Secret string `json:"secret,omitempty"`

+	Secret string `json:"secret,omitempty" description:"secret used to validate requests"`

 }

 // ImageChangeTrigger allows builds to be triggered when an ImageStream changes

 type ImageChangeTrigger struct {

 	// LastTriggeredImageID is used internally by the ImageChangeController to save last

 	// used image ID for build

-	LastTriggeredImageID string `json:"lastTriggeredImageID,omitempty"`

+	LastTriggeredImageID string `json:"lastTriggeredImageID,omitempty" description:"used internally to save last used image ID for build"`

 }

 // BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.

 type BuildTriggerPolicy struct {

 	// Type is the type of build trigger

-	Type BuildTriggerType `json:"type,omitempty"`

+	Type BuildTriggerType `json:"type,omitempty" description:"type of build trigger"`

 	// GithubWebHook contains the parameters for a GitHub webhook type of trigger

-	GithubWebHook *WebHookTrigger `json:"github,omitempty"`

+	GithubWebHook *WebHookTrigger `json:"github,omitempty" description:"parameters for a GitHub webhook type of trigger"`

 	// GenericWebHook contains the parameters for a Generic webhook type of trigger

-	GenericWebHook *WebHookTrigger `json:"generic,omitempty"`

+	GenericWebHook *WebHookTrigger `json:"generic,omitempty" description:"parameters for a Generic webhook type of trigger"`

 	// ImageChange contains parameters for an ImageChange type of trigger

-	ImageChange *ImageChangeTrigger `json:"imageChange,omitempty"`

+	ImageChange *ImageChangeTrigger `json:"imageChange,omitempty" description:"parameters for an ImageChange type of trigger"`

 }

 // BuildTriggerType refers to a specific BuildTriggerPolicy implementation.

@@ -352,23 +352,23 @@ const (

 type BuildList struct {

 	kapi.TypeMeta `json:",inline"`

 	kapi.ListMeta `json:"metadata,omitempty"`

-	Items         []Build `json:"items"`

+	Items         []Build `json:"items" description:"list of builds"`

 }

 // BuildConfigList is a collection of BuildConfigs.

 type BuildConfigList struct {

 	kapi.TypeMeta `json:",inline"`

 	kapi.ListMeta `json:"metadata,omitempty"`

-	Items         []BuildConfig `json:"items"`

+	Items         []BuildConfig `json:"items" description:"list of build configs"`

 }

 // GenericWebHookEvent is the payload expected for a generic webhook post

 type GenericWebHookEvent struct {

 	// Type is the type of source repository

-	Type BuildSourceType `json:"type,omitempty"`

+	Type BuildSourceType `json:"type,omitempty" description:"type of source repository"`

 	// Git is the git information if the Type is BuildSourceGit

-	Git *GitInfo `json:"git,omitempty"`

+	Git *GitInfo `json:"git,omitempty" description:"git information if type is git"`

 }

 // GitInfo is the aggregated git information for a generic webhook post

@@ -389,10 +389,10 @@ type BuildRequest struct {

 	kapi.ObjectMeta `json:"metadata,omitempty"`

 	// Revision is the information from the source for a specific repo snapshot.

-	Revision *SourceRevision `json:"revision,omitempty"`

+	Revision *SourceRevision `json:"revision,omitempty" description:"information from the source for a specific repo snapshot"`

 	// TriggeredByImage is the Image that triggered this build.

-	TriggeredByImage *kapi.ObjectReference `json:"triggeredByImage,omitempty"`

+	TriggeredByImage *kapi.ObjectReference `json:"triggeredByImage,omitempty" description:"image that triggered this build"`

 }

 // BuildLogOptions is the REST options for a build log