make jobstatus documenation more accurate

This commit is contained in:
Mike Danese 2015-09-29 11:41:52 -07:00
parent 26c51881ca
commit 076d2de3c6
3 changed files with 3 additions and 5 deletions

View File

@ -435,8 +435,7 @@ type JobStatus struct {
// Successful is the number of pods which reached Phase Succeeded. // Successful is the number of pods which reached Phase Succeeded.
Successful int `json:"successful,omitempty"` Successful int `json:"successful,omitempty"`
// Unsuccessful is the number of pods failures, this applies only to jobs // Unsuccessful is the number of pods which reached Phase Failed.
// created with RestartPolicyNever, otherwise this value will always be 0.
Unsuccessful int `json:"unsuccessful,omitempty"` Unsuccessful int `json:"unsuccessful,omitempty"`
} }

View File

@ -444,8 +444,7 @@ type JobStatus struct {
// Successful is the number of pods which reached Phase Succeeded. // Successful is the number of pods which reached Phase Succeeded.
Successful int `json:"successful,omitempty"` Successful int `json:"successful,omitempty"`
// Unsuccessful is the number of pods failures, this applies only to jobs // Unsuccessful is the number of pods which reached Phase Failed.
// created with RestartPolicyNever, otherwise this value will always be 0.
Unsuccessful int `json:"unsuccessful,omitempty"` Unsuccessful int `json:"unsuccessful,omitempty"`
} }

View File

@ -302,7 +302,7 @@ var map_JobStatus = map[string]string{
"completionTime": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "completionTime": "CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.",
"active": "Active is the number of actively running pods.", "active": "Active is the number of actively running pods.",
"successful": "Successful is the number of pods which reached Phase Succeeded.", "successful": "Successful is the number of pods which reached Phase Succeeded.",
"unsuccessful": "Unsuccessful is the number of pods failures, this applies only to jobs created with RestartPolicyNever, otherwise this value will always be 0.", "unsuccessful": "Unsuccessful is the number of pods which reached Phase Failed.",
} }
func (JobStatus) SwaggerDoc() map[string]string { func (JobStatus) SwaggerDoc() map[string]string {