-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #653 from zapier/PDE-5230-doc-update
PDE-5230: Sync CLI docs
- Loading branch information
Showing
2 changed files
with
14 additions
and
9 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,7 +24,7 @@ You may find some documents on the Zapier site duplicate or outdated. The most u | |
|
||
Our code is updated frequently. To see a full list of changes, look no further than [the CHANGELOG](https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md). | ||
|
||
This doc describes the latest CLI version (**15.8.0**), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases: | ||
This doc describes the latest CLI version (**15.11.1**), as of this writing. If you're using an older version of the CLI, you may want to check out these historical releases: | ||
|
||
- CLI Docs: [14.x](https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/README.md), [13.x](https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/README.md) | ||
- CLI Reference: [14.x](https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/docs/cli.md), [13.x](https://github.com/zapier/zapier-platform/blob/[email protected]/packages/cli/docs/cli.md) | ||
|
@@ -1996,6 +1996,7 @@ You'll usually want to use `bundle.inputData` instead. | |
| `limit` | `-1` | The number of items you should fetch. `-1` indicates there's no limit. Build this into your calls insofar as you are able | | ||
| `page` | `0` | Used in [paging](#paging) to uniquely identify which page of results should be returned | | ||
| `isTestingAuth` | `false` | (legacy property) If true, the poll was triggered by a user testing their account (via [clicking "test"](https://cdn.zapier.com/storage/photos/5c94c304ce11b02c073a973466a7b846.png) or during setup). We use this data to populate the auth label, but it's mostly used to verify we made a successful authenticated request | | ||
| `withSearch` | `undefined` | When a create is called as part of a search-or-create step, `withSearch` will be the key of the search. | | ||
> Before v8.0.0, the information in `bundle.meta` was different. See [the old docs](https://github.com/zapier/zapier-platform-cli/blob/a058e6d538a75d215d2e0c52b9f49a97218640c4/README.md#bundlemeta) for the previous values and [the wiki](https://github.com/zapier/zapier-platform/wiki/bundle.meta-changes) for a mapping of old values to new. | ||
|
@@ -2551,7 +2552,7 @@ This behavior has changed periodically across major versions, which changes how/ | |
![](https://cdn.zappy.app/e835d9beca1b6489a065d51a381613f3.png) | ||
Ensure you're handling errors correctly for your platform version. The latest released version is **15.8.0**. | ||
Ensure you're handling errors correctly for your platform version. The latest released version is **15.11.1**. | ||
### HTTP Request Options | ||
|
@@ -3670,6 +3671,8 @@ Since v15.6.0, instead of using the default `id` field, you can also define one | |
will tell Zapier to use `(userId, slug)` as the unique primary key to deduplicate items when running a polling trigger. | ||
**Limitation:** The `primary` option currently doesn't support mixing top-level fields with nested fields that use double underscores in their keys. For example, if you set `primary: true` on both `id` and `user__id`, the `primary` setting on the `user__id` field will be ignored; only `id` will be used for deduplication. However, if all the `primary` fields are all nested, such as `user__id` + `user__name`, it will work as expected. | ||
### Node X No Longer Supported | ||
If you're seeing errors like the following: | ||
|
@@ -3748,7 +3751,7 @@ Broadly speaking, all releases will continue to work indefinitely. While you nev | |
For more info about which Node versions are supported, see [the faq](#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with). | ||
<!-- TODO: if we decouple releases, change this --> | ||
The most recently released version of `cli` and `core` is **15.8.0**. You can see the versions you're working with by running `zapier -v`. | ||
The most recently released version of `cli` and `core` is **15.11.1**. You can see the versions you're working with by running `zapier -v`. | ||
To update `cli`, run `npm install -g zapier-platform-cli`. | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -361,17 +361,19 @@ Since a migration is only for non-breaking changes, users are not emailed about | |
|
||
We recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert. | ||
|
||
You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps in any account the user is a member of where the following criteria is met. | ||
You can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate Zaps that are private for that user. Zaps that are | ||
|
||
- The Zap is owned by the user. | ||
- [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629), | ||
|
||
- The Zap is not shared. | ||
- [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or | ||
|
||
- The integration auth used is not shared. | ||
- in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account) | ||
|
||
Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all users' Zaps, Private & Shared, within all accounts for which the specified user is a member. | ||
will **not** be migrated. | ||
|
||
**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Company accounts.** | ||
Alternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 [email protected]`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member. | ||
|
||
**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.** | ||
|
||
You cannot pass both `PERCENT` and `--user` or `--account`. | ||
|
||
|