This repository has been archived by the owner on Aug 14, 2020. It is now read-only.
Params V2 docs #41
Open
Params V2 docs #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dylburger
reviewed
Aug 13, 2020
|
|
||
| ## What are params? | ||
|
|
||
| Params are form inputs that can be added to code steps in a workflow to abstract data from the code and improve reusability. Most actions use params to capture user input (e.g., to allow users to customize the URL, method and payload for the Send HTTP Request action). You can reference objects in scope (e.g., `event`, `steps`, `process.env`) in params inputs to pass dynamic data to a step. |
There was a problem hiding this comment.
extra space in "You can reference"
dylburger
reviewed
Aug 13, 2020
| + [Adding params to a code step](#adding-params-to-a-code-step) | ||
| + [Configuring the params form](#configuring-the-params-form) | ||
|
|
||
| ## Entering Expressions |
There was a problem hiding this comment.
It's not immediately clear that I can enter JavaScript expressions, even in the "Manually enter or edit an expression" section - maybe elaborate on that fact?
dylburger
reviewed
Aug 13, 2020
|
|
||
| ### Basic Params | ||
|
|
||
| Basic params support simple values or, expressions in <code>{{...}}</code>. You can enter expressions by copying the path from step observability, using the object explorer below the params input, or by manually entering a value within <code>{{...}}</code> (Pipedream provides autocomplete for the objects in scope, but you can also enter a value that is not supported by autocomplete). |
There was a problem hiding this comment.
"Basic params support simple values or," -> no comma necessary
dylburger
reviewed
Aug 13, 2020
| @@ -0,0 +1,5 @@ | |||
| # test | |||
There was a problem hiding this comment.
Did you mean to include this file in the commit?
dylburger
reviewed
Aug 13, 2020
| @@ -0,0 +1,103 @@ | |||
| # Params | |||
There was a problem hiding this comment.
I realized this copy and the other README are both included - did you mean to include this file in the commit?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.