[SUPPORTENG-394] docs(cli): Add information about how to return line items #620
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
RasHanz
previously approved these changes
Feb 9, 2023
There was a problem hiding this comment.
Note: I just reviewed one pair of documents. I'm assuming the other two are necessary duplicates.
The only change I'd ask you to consider, @armchairlinguist, is the one about the "for examples", but I won't be opposed if you decide not to include that.
Feel free to send another review request if you include it, and I'll approve it quickly.
Comment on lines
+536
to
+538
| | Trigger | Array | 0 or more objects; passed to the [deduper](https://platform.zapier.com/docs/dedupe/) if polling | | ||
| | Search | Array | 0 or more objects. Only the first object will be returned, so if len > 1, put the best match first | | ||
| | Action | Object | Return values are evaluated by [`isPlainObject`](https://lodash.com/docs#isPlainObject) | | ||
| | Create | Object | Return values are evaluated by [`isPlainObject`](https://lodash.com/docs#isPlainObject) | |
| users: [ | ||
| { name: 'Zap Zaplar', age: 12, city: 'Columbia', region: 'Missouri' }, | ||
| { name: 'Orange Crush', age: 28, city: 'West Ocean City', region: 'Maryland' }, | ||
| { name: 'Lego Brick', age: 91, city: 'Billund', region: 'Denmark' }, |
|
|
||
| A standard search would return just the inner array of users, and only the first user would be provided as a final result. Returning line items instead means that the "first result" return is the object containing all the user details within it. | ||
|
|
||
| Using the standard approach is recommended, because not all Zapier integrations support line items directly, so users may need to take additional actions to reformat this data for use in their Zaps. More detail on that at [Use line items in Zaps](https://zapier.com/help/create/basics/use-line-items-in-zaps). However, there are use cases where returning multiple results is helpful enough to outweigh that additional effort. |
|
Thanks! I'll leave it open til Monday in case anyone on the eng team has feedback, as well. |
eliangcs
previously approved these changes
Feb 13, 2023
armchairlinguist
dismissed stale reviews from eliangcs and RasHanz
via
3ebfda9
Co-authored-by: Chang-Hung Liang <[email protected]>
eliangcs
approved these changes
Feb 15, 2023
armchairlinguist
deleted the
SUPPORTENG-394-return-line-items-from-a-step
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The question of how to correctly return line items comes up periodically, to the point where we maintain an internal reference. This addition will allow developers curious about how to return line items to better self-serve.