Skip to content
This repository was archived by the owner on Nov 29, 2024. It is now read-only.

PDE-4871 Sync docs #605

Open
standielpls wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PDE-4871 Sync docs #605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/_reference/cli-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,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.6.1**), 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.7.0**), 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/zapier-platform-cli@14.1.2/packages/cli/README.md), [13.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/README.md)
- CLI Reference: [14.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@14.1.2/packages/cli/docs/cli.md), [13.x](https://github.com/zapier/zapier-platform/blob/zapier-platform-cli@13.0.0/packages/cli/docs/cli.md)
Expand Down Expand Up @@ -295,15 +295,15 @@ $ tree .
├── index.js
├── package.json
├── triggers
│   └── contact-by-tag.js
│ └── contact-by-tag.js
├── resources
│   └── Contact.js
│ └── Contact.js
├── test
│   ├── basic.js
│   ├── triggers.js
│   └── resources.js
│ ├── basic.js
│ ├── triggers.js
│ └── resources.js
├── build
│   └── build.zip
│ └── build.zip
└── node_modules
├── ...
└── ...
Expand Down Expand Up @@ -873,8 +873,8 @@ Also, `authentication.oauth2Config.getAccessToken` has access to the additional

If you define `fields` to collect additional details from the user, please note that `client_id` and `client_secret` are reserved keys and cannot be used as keys for input form fields.

> Note: The OAuth2 `state` param is a [standard security feature](https://auth0.com/docs/secure/attack-protection/state-parameters) that helps ensure that authorization requests are only coming from your servers. Most OAuth clients have support for this and will send back the `state` query param that the user brings to your app. The Zapier Platform performs this check and this required field cannot be disabled. The state parameter is automatically generated by Zapier in the background, and can be accessed at `bundle.inputData.state`.
Since Zapier uses the `state` to verify that GET requests to your redirect URL truly come from your app, it needs to be generated by Zapier so that it can be validated later (once the user confirms that they'd like to grant Zapier permission to access their account in your app).
> Note: The OAuth2 `state` param is a [standard security feature](https://auth0.com/docs/secure/attack-protection/state-parameters) that helps ensure that authorization requests are only coming from your servers. Most OAuth clients have support for this and will send back the `state` query param that the user brings to your app. The Zapier Platform performs this check and this required field cannot be disabled. The state parameter is automatically generated by Zapier in the background, and can be accessed at `bundle.inputData.state`.
Since Zapier uses the `state` to verify that GET requests to your redirect URL truly come from your app, it needs to be generated by Zapier so that it can be validated later (once the user confirms that they'd like to grant Zapier permission to access their account in your app).


### OAuth2 with PKCE
Expand Down Expand Up @@ -1237,7 +1237,7 @@ Notably, fields come in different types, which may look and act differently in t
| `datetime` | Accepts both [precise and human-readable date-time values](https://help.zapier.com/hc/en-us/articles/8496259603341-Different-field-types-in-Zaps#date-time-fields-0-0). Passes along an ISO-formatted time string. |
| `file` | Accepts a file object or a string. If a URL is provided in the string, Zapier will automatically make a GET for that file. Otherwise, a text file will be generated. |
| `password` | Displays entered characters as hidden, accepts text input. Does not accept input from previous steps. |
| `copy` | Does not allow users enter data. Shows the value of the Markdown-formatted Help Text for the field as a rich text note in the Zap editor. Good for important notices to users. |
| `copy` | Does not allow users to enter data. Shows the value of the Markdown-formatted Help Text for the field as a rich text note in the Zap editor. Good for important notices to users. |

You can find more details on the different field schema options at [our Field Schema](https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md#fieldschema).

Expand Down Expand Up @@ -2494,7 +2494,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.6.1**.
Ensure you're handling errors correctly for your platform version. The latest released version is **15.7.0**.

### HTTP Request Options

Expand Down Expand Up @@ -3691,7 +3691,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.6.1**. You can see the versions you're working with by running `zapier -v`.
The most recently released version of `cli` and `core` is **15.7.0**. You can see the versions you're working with by running `zapier -v`.

To update `cli`, run `npm install -g zapier-platform-cli`.

Expand All @@ -3701,7 +3701,7 @@ For maximum compatibility, keep the versions of `cli` and `core` in sync.

## Get Help!

You can get help by either emailing `partners@zapier.com` or by [joining our developer community here](https://community.zapier.com/p/developer-zone).
You can get help by either emailing `partners@zapier.com` or by [joining our developer community here](https://community.zapier.com/developer-discussion-13).

---

Expand Down