update swagger spec for enums (#564)

api/buildsecrets/models/build_secret.go

@@ -14,6 +14,7 @@ type BuildSecret struct {
 	// - Consistent = Secret value is set
 	//
 	// required: false
+	// enum: Pending,Consistent
 	// example: Consistent
 	Status string `json:"status"`
 }

api/deployments/models/component_deployment.go

@@ -21,6 +21,7 @@ type Component struct {
 	// Type of component
 	//
 	// required: true
+	// enum: component,job
 	// example: component
 	Type string `json:"type"`
 
@@ -30,6 +31,7 @@ type Component struct {
 	// - Consistent = Component is consistent with config
 	// - Restarting = User has triggered restart, but this is not reconciled
 	//
+	// enum: Stopped,Consistent,Reconciling,Restarting,Outdated
 	// example: Consistent
 	Status string `json:"status"`
 
@@ -159,6 +161,7 @@ type AuxiliaryResourceDeployment struct {
 	// - Reconciling: Waiting for new replicas to enter desired state
 	// - Stopped: Replica count is set to 0
 	//
+	// enum: Stopped,Consistent,Reconciling
 	// example: Consistent
 	Status string `json:"status"`
 
@@ -196,6 +199,7 @@ type ComponentSummary struct {
 	// Type of component
 	//
 	// required: true
+	// enum: component,job
 	// example: component
 	Type string `json:"type"`
 
@@ -269,8 +273,8 @@ type ReplicaStatus struct {
 	// - Running = Container in Running state
 	// - Terminated = Container in Terminated state
 	//
-	// Enum: Pending,Failing,Running,Terminated,Starting
 	// required: true
+	// enum: Pending,Failing,Running,Terminated,Starting
 	// example: Running
 	Status string `json:"status"`
 }

api/deployments/models/deployment_summary.go

@@ -9,6 +9,7 @@ type DeploymentSummaryPipelineJobInfo struct {
 	// Type of pipeline job
 	//
 	// required: false
+	// enum: build,build-deploy,promote,deploy
 	// example: build-deploy
 	PipelineJobType string `json:"pipelineJobType,omitempty"`
 

api/deployments/models/scheduled_batch.go

@@ -30,7 +30,7 @@ type ScheduledJobSummary struct {
 	// Status of the job
 	//
 	// required: true
-	// Enum: Waiting,Running,Succeeded,Stopping,Stopped,Failed
+	// enum: Running,Succeeded,Failed,Waiting,Stopping,Stopped
 	// example: Waiting
 	Status string `json:"status"`
 
@@ -125,7 +125,7 @@ type ScheduledBatchSummary struct {
 	// Status of the job
 	//
 	// required: true
-	// Enum: Waiting,Running,Succeeded,Failed
+	// enum: Waiting,Running,Succeeded,Failed
 	// example: Waiting
 	Status string `json:"status"`
 

api/environments/models/environment.go

@@ -20,7 +20,7 @@ type Environment struct {
 	// - Orphan = Environment does not exist in Radix config, but exists in cluster
 	//
 	// required: false
-	// Enum: Pending,Consistent,Orphan
+	// enum: Pending,Consistent,Orphan
 	// example: Consistent
 	Status string `json:"status"`
 

api/environments/models/environment_summary.go

@@ -19,7 +19,7 @@ type EnvironmentSummary struct {
 	// - Orphan = Environment does not exist in Radix config, but exists in cluster
 	//
 	// required: false
-	// Enum: Pending,Consistent,Orphan
+	// enum: Pending,Consistent,Orphan
 	// example: Consistent
 	Status string `json:"status"`
 

api/jobs/models/job.go

@@ -34,7 +34,7 @@ type Job struct {
 	// Image tags names for components - if empty will use default logic
 	//
 	// required: false
-	// Example: component1: tag1,component2: tag2
+	// example: component1: tag1,component2: tag2
 	ImageTagNames map[string]string `json:"imageTagNames,omitempty"`
 
 	// Created timestamp
@@ -70,14 +70,14 @@ type Job struct {
 	// Status of the job
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Stopping,Stopped,Failed,StoppedNoChanges
+	// enum: Queued,Waiting,Running,Succeeded,Failed,Stopped,Stopping,StoppedNoChanges
 	// example: Waiting
 	Status string `json:"status"`
 
 	// Name of the pipeline
 	//
 	// required: false
-	// Enum: build,build-deploy,promote,deploy
+	// enum: build,build-deploy,promote,deploy
 	// example: build-deploy
 	Pipeline string `json:"pipeline"`
 

api/jobs/models/job_parameters.go

@@ -34,7 +34,8 @@ type JobParameters struct {
 	ImageTag string
 
 	// ImageTagNames tags for components - if empty will use default logic
-	// Example: component1=tag1,component2=tag2
+	//
+	// example: component1=tag1,component2=tag2
 	ImageTagNames map[string]string
 }
 

api/jobs/models/job_summary.go

@@ -35,7 +35,7 @@ type JobSummary struct {
 	// Image tags names for components - if empty will use default logic
 	//
 	// required: false
-	// Example: component1: tag1,component2: tag2
+	// example: component1: tag1,component2: tag2
 	ImageTagNames map[string]string `json:"imageTagNames,omitempty"`
 
 	// Created timestamp
@@ -65,14 +65,14 @@ type JobSummary struct {
 	// Status of the job
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Stopping,Stopped,Failed,StoppedNoChanges
+	// enum: Queued,Waiting,Running,Succeeded,Failed,Stopped,Stopping,StoppedNoChanges
 	// example: Waiting
 	Status string `json:"status"`
 
 	// Name of the pipeline
 	//
 	// required: false
-	// Enum: build,build-deploy,promote,deploy
+	// enum: build,build-deploy,promote,deploy
 	// example: build-deploy
 	Pipeline string `json:"pipeline"`
 

api/jobs/models/pipeline_run.go

@@ -24,8 +24,7 @@ type PipelineRun struct {
 	// Status of the step
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Failed
-	// example: Waiting
+	// example: Started
 	Status string `json:"status"`
 
 	// StatusMessage of the task

api/jobs/models/pipeline_run_task.go

@@ -30,8 +30,7 @@ type PipelineRunTask struct {
 	// Status of the task
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Failed
-	// example: Waiting
+	// example: Running
 	Status string `json:"status"`
 
 	// StatusMessage of the task

api/jobs/models/pipeline_run_task_step.go

@@ -12,8 +12,7 @@ type PipelineRunTaskStep struct {
 	// Status of the task
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Failed
-	// example: Waiting
+	// example: Completed
 	Status string `json:"status"`
 
 	// StatusMessage of the task

api/jobs/models/step.go

@@ -12,7 +12,7 @@ type Step struct {
 	// Status of the step
 	//
 	// required: false
-	// Enum: Waiting,Running,Succeeded,Failed
+	// enum: Queued,Waiting,Running,Succeeded,Failed,Stopped,StoppedNoChanges
 	// example: Waiting
 	Status string `json:"status"`
 

api/privateimagehubs/models/image_hub_secret.go

@@ -26,6 +26,7 @@ type ImageHubSecret struct {
 	// - Consistent = Secret value is set
 	//
 	// required: false
+	// enum: Pending,Consistent
 	// example: Consistent
 	Status string `json:"status"`
 }

api/secrets/models/secret.go

@@ -20,7 +20,8 @@ type Secret struct {
 	// Type of the secret
 	//
 	// required: false
-	// example: csi-az-blob
+	// enum: generic,client-cert,azure-blob-fuse-volume,csi-azure-blob-volume,csi-azure-key-vault-creds,csi-azure-key-vault-item,client-cert-auth,oauth2-proxy
+	// example: client-cert
 	Type SecretType `json:"type,omitempty"`
 
 	// Resource of the secrets
@@ -47,6 +48,7 @@ type Secret struct {
 	// - NotAvailable = Secret is available in external secret configuration but not in cluster
 	//
 	// required: false
+	// enum: Pending,Consistent,NotAvailable,Invalid
 	// example: Consistent
 	Status string `json:"status,omitempty"`
 

api/secrets/models/secret_parameters.go

@@ -12,6 +12,7 @@ type SecretParameters struct {
 	// Type of the secret
 	//
 	// required: false
-	// example: csi-az-blob
+	// enum: generic,client-cert,azure-blob-fuse-volume,csi-azure-blob-volume,csi-azure-key-vault-creds,csi-azure-key-vault-item,client-cert-auth,oauth2-proxy
+	// example: azure-blob-fuse-volume
 	Type SecretType `json:"type,omitempty"`
 }