Merge pull request #11246 from kargakis/fix-api-godoc

Merged by openshift-bot
openshift · Oct 18, 2016 · 6ccac60 · 6ccac60
2 parents 0145d19 + 46ea673
commit 6ccac60
Show file tree

Hide file tree

Showing 8 changed files with 376 additions and 432 deletions.
diff --git a/api/protobuf-spec/github_com_openshift_origin_pkg_deploy_api_v1.proto b/api/protobuf-spec/github_com_openshift_origin_pkg_deploy_api_v1.proto
diff --git a/api/swagger-spec/oapi-v1.json b/api/swagger-spec/oapi-v1.json
@@ -23242,7 +23242,7 @@
      },
      "customParams": {
       "$ref": "v1.CustomDeploymentStrategyParams",
-      "description": "CustomParams are the input to the Custom deployment strategy."
+      "description": "CustomParams are the input to the Custom deployment strategy, and may also be specified for the Recreate and Rolling strategies to customize the execution process that runs the deployment."
      },
      "recreateParams": {
       "$ref": "v1.RecreateDeploymentStrategyParams",
@@ -23254,7 +23254,7 @@
      },
      "resources": {
       "$ref": "v1.ResourceRequirements",
-      "description": "Resources contains resource requirements to execute the deployment and any hooks"
+      "description": "Resources contains resource requirements to execute the deployment and any hooks."
      },
      "labels": {
       "type": "object",
@@ -23423,7 +23423,7 @@
      },
      "post": {
       "$ref": "v1.LifecycleHook",
-      "description": "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. The LifecycleHookFailurePolicyAbort policy is NOT supported."
+      "description": "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported."
      }
     }
    },

diff --git a/pkg/deploy/api/types.go b/pkg/deploy/api/types.go
diff --git a/pkg/deploy/api/v1/generated.proto b/pkg/deploy/api/v1/generated.proto
diff --git a/pkg/deploy/api/v1/swagger_doc.go b/pkg/deploy/api/v1/swagger_doc.go
@@ -177,10 +177,10 @@ func (DeploymentRequest) SwaggerDoc() map[string]string {
 var map_DeploymentStrategy = map[string]string{
 	"":               "DeploymentStrategy describes how to perform a deployment.",
 	"type":           "Type is the name of a deployment strategy.",
-	"customParams":   "CustomParams are the input to the Custom deployment strategy.",
+	"customParams":   "CustomParams are the input to the Custom deployment strategy, and may also be specified for the Recreate and Rolling strategies to customize the execution process that runs the deployment.",
 	"recreateParams": "RecreateParams are the input to the Recreate deployment strategy.",
 	"rollingParams":  "RollingParams are the input to the Rolling deployment strategy.",
-	"resources":      "Resources contains resource requirements to execute the deployment and any hooks",
+	"resources":      "Resources contains resource requirements to execute the deployment and any hooks.",
 	"labels":         "Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.",
 	"annotations":    "Annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.",
 }
@@ -254,7 +254,7 @@ var map_RollingDeploymentStrategyParams = map[string]string{
 	"maxUnavailable":      "MaxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding up.\n\nThis cannot be 0 if MaxSurge is 0. By default, 25% is used.\n\nExample: when this is set to 30%, the old RC can be scaled down by 30% immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that at least 70% of original number of pods are available at all times during the update.",
 	"maxSurge":            "MaxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up.\n\nThis cannot be 0 if MaxUnavailable is 0. By default, 25% is used.\n\nExample: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods.",
 	"pre":                 "Pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.",
-	"post":                "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. The LifecycleHookFailurePolicyAbort policy is NOT supported.",
+	"post":                "Post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.",
 }
 
 func (RollingDeploymentStrategyParams) SwaggerDoc() map[string]string {