docs: correctly document result output parameter (#13953)

Signed-off-by: Mason Malone <[email protected]>

docs/executor_swagger.md

@@ -2462,7 +2462,7 @@ save/load the directory appropriately.
 | artifacts | [Artifacts](#artifacts)| `Artifacts` |  | |  |  |
 | exitCode | string| `string` |  | | ExitCode holds the exit code of a script template |  |
 | parameters | [][Parameter](#parameter)| `[]*Parameter` |  | | Parameters holds the list of output parameters produced by a step</br>+patchStrategy=merge</br>+patchMergeKey=name |  |
-| result | string| `string` |  | | Result holds the result (stdout) of a script template |  |
+| result | string| `string` |  | | Result holds the result (stdout) of a script or container template, or the response body of an HTTP template |  |
 
 
 

docs/fields.md

@@ -2004,7 +2004,7 @@ Outputs hold parameters, artifacts, and results from a step
 |`artifacts`|`Array<`[`Artifact`](#artifact)`>`|Artifacts holds the list of output artifacts produced by a step|
 |`exitCode`|`string`|ExitCode holds the exit code of a script template|
 |`parameters`|`Array<`[`Parameter`](#parameter)`>`|Parameters holds the list of output parameters produced by a step|
-|`result`|`string`|Result holds the result (stdout) of a script template|
+|`result`|`string`|Result holds the result (stdout) of a script or container template, or the response body of an HTTP template|
 
 ## SynchronizationStatus
 

docs/http-template.md

@@ -3,6 +3,7 @@
 > v3.2 and after
 
 `HTTP Template` is a type of template which can execute HTTP Requests.
+The body of the response is automatically exported into the `result` output parameter.
 
 ```yaml
 apiVersion: argoproj.io/v1alpha1

docs/variables.md

@@ -146,7 +146,7 @@ sprig.trim(inputs.parameters['my-string-param'])
 | `steps.<STEPNAME>.startedAt` | Time-stamp when the step started |
 | `steps.<STEPNAME>.finishedAt` | Time-stamp when the step finished |
 | `steps.<TASKNAME>.hostNodeName` | Host node where task ran (available from version 3.5) |
-| `steps.<STEPNAME>.outputs.result` | Output result of any previous container or script step |
+| `steps.<STEPNAME>.outputs.result` | Output result of any previous container, script, or HTTP step |
 | `steps.<STEPNAME>.outputs.parameters` | When the previous step uses `withItems` or `withParams`, this contains a JSON array of the output parameter maps of each invocation |
 | `steps.<STEPNAME>.outputs.parameters.<NAME>` | Output parameter of any previous step. When the previous step uses `withItems` or `withParams`, this contains a JSON array of the output parameter values of each invocation |
 | `steps.<STEPNAME>.outputs.artifacts.<NAME>` | Output artifact of any previous step |
@@ -163,7 +163,7 @@ sprig.trim(inputs.parameters['my-string-param'])
 | `tasks.<TASKNAME>.startedAt` | Time-stamp when the task started |
 | `tasks.<TASKNAME>.finishedAt` | Time-stamp when the task finished |
 | `tasks.<TASKNAME>.hostNodeName` | Host node where task ran (available from version 3.5) |
-| `tasks.<TASKNAME>.outputs.result` | Output result of any previous container or script task |
+| `tasks.<TASKNAME>.outputs.result` | Output result of any previous container, script, or HTTP task |
 | `tasks.<TASKNAME>.outputs.parameters` | When the previous task uses `withItems` or `withParams`, this contains a JSON array of the output parameter maps of each invocation |
 | `tasks.<TASKNAME>.outputs.parameters.<NAME>` | Output parameter of any previous task. When the previous task uses `withItems` or `withParams`, this contains a JSON array of the output parameter values of each invocation |
 | `tasks.<TASKNAME>.outputs.artifacts.<NAME>` | Output artifact of any previous task |

docs/walk-through/output-parameters.md

@@ -47,9 +47,9 @@ DAG templates use the tasks prefix to refer to another task, for example `{{task
 
 ## `result` output parameter
 
-The `result` output parameter captures standard output.
+For script and container templates, the `result` output parameter captures up to 256 kb of the standard output.
+For HTTP templates, `result` captures the response body.
 It is accessible from the `outputs` map: `outputs.result`.
-Only 256 kb of the standard output stream will be captured.
 
 ### Scripts
 
@@ -59,3 +59,7 @@ Outputs of a `script` are assigned to standard output and captured in the `resul
 
 Container steps and tasks also have their standard output captured in the `result` parameter.
 Given a `task`, called `log-int`, `result` would then be accessible as `{{ tasks.log-int.outputs.result }}`. If using [steps](steps.md), substitute `tasks` for `steps`: `{{ steps.log-int.outputs.result }}`.
+
+### HTTP
+
+[HTTP templates](../http-template.md) capture the response body in the `result` parameter if the body is non-empty.

pkg/apis/workflow/v1alpha1/workflow_types.go

@@ -1479,7 +1479,7 @@ type Outputs struct {
 	// +patchMergeKey=name
 	Artifacts Artifacts `json:"artifacts,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=artifacts"`
 
-	// Result holds the result (stdout) of a script template
+	// Result holds the result (stdout) of a script or container template, or the response body of an HTTP template
 	Result *string `json:"result,omitempty" protobuf:"bytes,3,opt,name=result"`
 
 	// ExitCode holds the exit code of a script template

pkg/plugins/executor/swagger.yml

@@ -2509,7 +2509,7 @@ definitions:
                     $ref: '#/definitions/Parameter'
                 type: array
             result:
-                description: Result holds the result (stdout) of a script template
+                description: Result holds the result (stdout) of a script or container template, or the response body of an HTTP template
                 type: string
         type: object
     OwnerReference: