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

Commit

Permalink
Merge pull request #545 from zapier/PDE-4452-sync-docs-15.5.1
Browse files Browse the repository at this point in the history
PDE-4452: Sync CLI docs 15.5.1
  • Loading branch information
eliangcs authored Nov 21, 2023
2 parents 4365968 + 65e89f7 commit 6cf9144
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 35 deletions.
48 changes: 24 additions & 24 deletions docs/_publish/integration-checks-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ redirect_from: /docs/integration-checks-reference

# Integration Checks Reference

We run your integration through a set of automated checks to ensure it's working properly and giving our users (and yours) the best possible experience.
We run your integration through a set of automated checks to ensure it's working properly and giving our users (and yours) the best possible experience.

To [publish your integration](https://platform.zapier.com/publish/public-integration), all Errors and Publishing Tasks should be validated. You can address any Warnings after [submitting your integration for review](https://platform.zapier.com/publish/public-integration#4-submit-your-integration-for-app-review).

If your integration will remain private, it isn't necessary to clear validation checks. You can [invite others to test your integration](https://platform.zapier.com/build/test-integration#how-to-invite-others-to-test-new-integrations) before publication.
If your integration will remain private, it isn't necessary to clear validation checks. You can [invite others to test your integration](https://platform.zapier.com/manage/sharing) before publication.

To help better address a check in communication, each check is given a unique ID, consisting of a capital letter and three digits, such as `D001`.

Expand Down Expand Up @@ -117,9 +117,9 @@ Website Dashboard to find your API Key.
A Connection Label helps a customer remember which account they connected.
It should be short and easily identifiable.

For both [Platform UI](https://platform.zapier.com/build/auth#how-to-add-a-connection-label-to-authenticated-accounts)
and [CLI](https://platform.zapier.com/reference/cli-docs#authentication), the connection
label is a string. You can use any data returned by your test function.
For both [Platform UI](https://platform.zapier.com/build/connection-label)
and [CLI](https://platform.zapier.com/reference/cli-docs#connection-label), the
connection label is a string. You can use any data returned by your test function.

For instance, if a successful run of the auth test returns the following data:

Expand Down Expand Up @@ -164,8 +164,8 @@ still be able to map custom fields, but this gets them started on the right foot

Read more about implementing dynamic dropdowns below:

- Platform UI: https://platform.zapier.com/build/input-designer#dropdown
- Platform CLI: https://platform.zapier.com/reference/cli-docs#dynamic-dropdowns
- Platform UI: https://platform.zapier.com/build/field-definitions#dynamic-fields
- Platform CLI: https://platform.zapier.com/reference/cli-docs#dynamic-dropdowns

---

Expand Down Expand Up @@ -239,9 +239,7 @@ remove the `friends` information, and return only the array of contacts, not the
enclosing object.

The polling result is not used when a user skips testing the Zap step. In that case,
Zapier uses the sample data.

See [Sample Data](./faq#output) for more details on this.
Zapier uses the sample data. See [Sample Data](https://platform.zapier.com/build/sample-data) for more details on this.

---

Expand All @@ -250,8 +248,8 @@ See [Sample Data](./faq#output) for more details on this.
## D007 - All URLs Should Be HTTPS

When handling customer data (which all Zapier functions do), it's strongly
encouraged that all communication take place securely. Using SSL is a big part
of that, so ensure your URLs have HTTPS as their protocol.
encouraged that all communication take place securely. Using SSL is a big part of
that, so ensure your URLs have HTTPS as their protocol.

If you need help setting up an SSL certificate for your API, we suggest
[Let's Encrypt](https://letsencrypt.org/).
Expand Down Expand Up @@ -391,7 +389,7 @@ It's very important that the structure of an object from the actual trigger/acti
the sample data are identical. Otherwise, users could map fields that don't exist
in the live results, which results in a broken Zap.

See [Sample Data](./faq#output) for more details on this.
See [Sample Data](https://platform.zapier.com/build/sample-data) for more details on this.

---

Expand Down Expand Up @@ -706,7 +704,8 @@ To resize an image or convert an image to PNG, you can use this
To ensure that this integration is being submitted by the app owner we require that
one of the Admin team members listed on the project have an email address with the same
domain as your app's homepage URL (which must also be present). You can add the homepage
URL at `https://zapier.com/app/developer/app/APP_ID/version/APP_VERSION/settings`. Collaborator team members with the same domain as the homepage do not meet this requirement.
URL at `https://developer.zapier.com/app/APP_ID/version/APP_VERSION/settings`.
Collaborator team members with the same domain as the homepage do not meet this requirement.

---

Expand All @@ -715,7 +714,7 @@ URL at `https://zapier.com/app/developer/app/APP_ID/version/APP_VERSION/settings
## M006 - Homepage URL Must Be Present

Each app must have a homepage URL. You can add the homepage
URL at `https://zapier.com/app/developer/app/APP_ID/version/APP_VERSION/settings`.
URL at `https://developer.zapier.com/app/APP_ID/version/APP_VERSION/settings`.

---

Expand All @@ -737,9 +736,9 @@ a new integration.

To verify user demand, there should be at least 3 users who have a live Zap using
this integration. "Live" means the Zaps are switched on with at least one successful
[Zap run in recent history](https://zapier.com/help/manage/history/view-and-manage-your-zap-history).
[Zap run in recent history](https://help.zapier.com/hc/en-us/articles/8496291148685).

You can [invite others to test your integration](https://platform.zapier.com/manage/share-integration)
You can [invite others to test your integration](https://platform.zapier.com/manage/sharing)
before publication.

---
Expand All @@ -751,10 +750,10 @@ before publication.
To ensure any show-stopping bugs are worked out, every visible trigger/search/action
of your integration should have a live Zap that demonstrates it works. "Live" means
the Zaps are switched on with at least one successful
[Zap run in recent history](https://zapier.com/help/manage/history/view-and-manage-your-zap-history).
[Zap run in recent history](https://help.zapier.com/hc/en-us/articles/8496291148685).

You can create a [new Zapier account](https://zapier.com/help/account/billing-pricing/get-started-with-your-free-zapier-trial)
and [invite it to your integration](https://platform.zapier.com/manage/share-integration)
You can create a [new Zapier account](https://help.zapier.com/hc/en-us/articles/8496197192461)
and [invite it to your integration](https://platform.zapier.com/manage/sharing)
if you need extra Zaps.

You can also [contact us](https://developer.zapier.com/contact) if you need a trial extension.
Expand Down Expand Up @@ -784,7 +783,7 @@ This check is performed using the [Zap History](https://zapier.com/app/history)
accounts belonging to the integration admins, so build your test Zaps in these
accounts.

Learn more about the Zap History [here](https://zapier.com/help/manage/history/view-and-manage-your-zap-history).
Learn more about the Zap History [here](https://help.zapier.com/hc/en-us/articles/8496291148685).

---

Expand Down Expand Up @@ -902,7 +901,7 @@ static: {"id": 1, "name": "John"}
live: {"id": 2, "name": "Alice", "email": "[email protected]"}
```

See [Sample Data](./faq#output) for more details on this.
See [Sample Data](https://platform.zapier.com/build/sample-data) for more details on this.

---

Expand Down Expand Up @@ -941,7 +940,7 @@ output fields: [
]
```

See [Sample Data](./faq#output) for more details on this.
See [Sample Data](https://platform.zapier.com/build/sample-data) for more details on this.

---

Expand Down Expand Up @@ -985,7 +984,8 @@ live: {"id": 2, "name": "Alice"}
polling sample: {"id": 1, "name": "John"}
live: {"id": 2, "name": "Alice", "email": "[email protected]"}
```
See [Sample Data](./faq#output) for more details on this.

See [Sample Data](https://platform.zapier.com/build/sample-data) for more details on this.

---

Expand Down
22 changes: 11 additions & 11 deletions docs/_reference/cli-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,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.5.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.5.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)
Expand Down Expand Up @@ -294,15 +294,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 @@ -872,8 +872,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 @@ -2464,7 +2464,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.5.0**.
Ensure you're handling errors correctly for your platform version. The latest released version is **15.5.1**.
### HTTP Request Options
Expand Down Expand Up @@ -3637,7 +3637,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.5.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.5.1**. You can see the versions you're working with by running `zapier -v`.
To update `cli`, run `npm install -g zapier-platform-cli`.
Expand Down

0 comments on commit 6cf9144

Please sign in to comment.