Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(cli): Update docs on throttle config object #760

Merged
merged 1 commit into from
Mar 25, 2024
Merged

docs(cli): Update docs on throttle config object #760

Show file tree
Hide file tree
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
32 changes: 29 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3655,16 +3655,24 @@ <h2 id="adding-throttle-configuration">Adding Throttle Configuration</h2>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p><em>Added in v15.4.0.</em></p><p>When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action&apos;s operation object, the root-level default is overwritten for that action only.</p><p>To throttle an action, you need to set a <code>throttle</code> object with the following variables:</p><ol>
<p><em>Added in v15.4.0.</em></p><p><em>Updated in v15.6.0</em></p><p>When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action&apos;s operation object, the root-level default is overwritten for that action only. Note that the throttle limit is not shared across actions unless for those with the same key, window, limit, and scope when &quot;action&quot; is not in the scope.</p><p>To throttle an action, you need to set a <code>throttle</code> object with the following variables:</p><ol>
<li><code>window [integer]</code>: The timeframe, in seconds, within which the system tracks the number of invocations for an action. The number of invocations begins at zero at the start of each window.</li>
<li><code>limit [integer]</code>: The maximum number of invocations for an action, allowed within the timeframe window.</li>
<li><code>key [string]</code>: The key to throttle with in combination with the scope. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field &quot;test_field&quot;, use <code>{{bundle.inputData.test_field}}</code>. Note that a required input field should be referenced to get user data always.</li>
<li><code>scope [array]</code>: The granularity to throttle by. You can set the scope to one or more of the following options;<ul>
<li>&apos;user&apos; - Throttles based on user ids.</li>
<li>&apos;auth&apos; - Throttles based on auth ids.</li>
<li>&apos;account&apos; - Throttles based on account ids for all users under a single account.</li>
<li>&apos;action&apos; - Throttles the action it is set on separately from other actions.</li>
</ul>
</li>
</ol><p>Except for the scope, all throttle variables are required. By default, throttling is scoped to the account.</p><p>Here is a typical usage of the throttle configuration:</p>
<li><code>overrides [array[object]]</code>: &apos;EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.&apos;;<ul>
<li><code>window [integer]</code>: Same description as above.</li>
<li><code>limit [integer]</code>: Same description as above.</li>
<li><code>filter [string]</code>: Account-based attribute to override the throttle by. You can set to one of the following: &quot;free&quot;, &quot;trial&quot;, &quot;paid&quot;. Therefore, the throttle scope would be automatically set to &quot;account&quot; and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.</li>
</ul>
</li>
</ol><p>Both <code>window</code> and <code>limit</code> are required and others are optional. By default, throttling is scoped to the action and account.</p><p>Here is a typical usage of the throttle configuration:</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-js"><span class="hljs-keyword">const</span> App = {
Expand All @@ -3687,12 +3695,30 @@ <h2 id="adding-throttle-configuration">Adding Throttle Configuration</h2>
},
<span class="hljs-attr">operation</span>: {
<span class="hljs-attr">perform</span>: <span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> {},
<span class="hljs-attr">inputFields</span>: [],
<span class="hljs-attr">inputFields</span>: [{<span class="hljs-attr">key</span>: <span class="hljs-string">&apos;name&apos;</span>, <span class="hljs-attr">required</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">type</span>: <span class="hljs-string">&apos;string&apos;</span>}],
<span class="hljs-comment">// overwrites the default, for this action</span>
<span class="hljs-attr">throttle</span>: {
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">5</span>,
<span class="hljs-attr">key</span>: <span class="hljs-string">&apos;test-key-{{bundle.inputData.name}}&apos;</span>,
<span class="hljs-attr">scope</span>: [<span class="hljs-string">&apos;account&apos;</span>],
<span class="hljs-attr">overrides</span>: [
{
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">10</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;free&apos;</span>,
},
{
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">100</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;trial&apos;</span>,
},
{
<span class="hljs-attr">window</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;paid&apos;</span>,
},
],
},
},
},
Expand Down
14 changes: 11 additions & 3 deletions packages/cli/README-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,17 +1158,25 @@ For example, you can access the `process.env` in your perform functions and in t

*Added in v15.4.0.*

When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action's operation object, the root-level default is overwritten for that action only.
*Updated in v15.6.0*

When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action's operation object, the root-level default is overwritten for that action only. Note that the throttle limit is not shared across actions unless for those with the same key, window, limit, and scope when "action" is not in the scope.

To throttle an action, you need to set a `throttle` object with the following variables:
1. `window [integer]`: The timeframe, in seconds, within which the system tracks the number of invocations for an action. The number of invocations begins at zero at the start of each window.
2. `limit [integer]`: The maximum number of invocations for an action, allowed within the timeframe window.
3. `scope [array]`: The granularity to throttle by. You can set the scope to one or more of the following options;
3. `key [string]`: The key to throttle with in combination with the scope. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field "test_field", use `{{bundle.inputData.test_field}}`. Note that a required input field should be referenced to get user data always.
4. `scope [array]`: The granularity to throttle by. You can set the scope to one or more of the following options;
- 'user' - Throttles based on user ids.
- 'auth' - Throttles based on auth ids.
- 'account' - Throttles based on account ids for all users under a single account.
- 'action' - Throttles the action it is set on separately from other actions.
5. `overrides [array[object]]`: 'EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.';
- `window [integer]`: Same description as above.
- `limit [integer]`: Same description as above.
- `filter [string]`: Account-based attribute to override the throttle by. You can set to one of the following: "free", "trial", "paid". Therefore, the throttle scope would be automatically set to "account" and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.

Except for the scope, all throttle variables are required. By default, throttling is scoped to the account.
Both `window` and `limit` are required and others are optional. By default, throttling is scoped to the action and account.

Here is a typical usage of the throttle configuration:

Expand Down
34 changes: 30 additions & 4 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2160,17 +2160,25 @@ const App = {

*Added in v15.4.0.*

When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action's operation object, the root-level default is overwritten for that action only.
*Updated in v15.6.0*

When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action's operation object, the root-level default is overwritten for that action only. Note that the throttle limit is not shared across actions unless for those with the same key, window, limit, and scope when "action" is not in the scope.

To throttle an action, you need to set a `throttle` object with the following variables:
1. `window [integer]`: The timeframe, in seconds, within which the system tracks the number of invocations for an action. The number of invocations begins at zero at the start of each window.
2. `limit [integer]`: The maximum number of invocations for an action, allowed within the timeframe window.
3. `scope [array]`: The granularity to throttle by. You can set the scope to one or more of the following options;
3. `key [string]`: The key to throttle with in combination with the scope. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field "test_field", use `{{bundle.inputData.test_field}}`. Note that a required input field should be referenced to get user data always.
4. `scope [array]`: The granularity to throttle by. You can set the scope to one or more of the following options;
- 'user' - Throttles based on user ids.
- 'auth' - Throttles based on auth ids.
- 'account' - Throttles based on account ids for all users under a single account.
- 'action' - Throttles the action it is set on separately from other actions.
5. `overrides [array[object]]`: 'EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.';
- `window [integer]`: Same description as above.
- `limit [integer]`: Same description as above.
- `filter [string]`: Account-based attribute to override the throttle by. You can set to one of the following: "free", "trial", "paid". Therefore, the throttle scope would be automatically set to "account" and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.

Except for the scope, all throttle variables are required. By default, throttling is scoped to the account.
Both `window` and `limit` are required and others are optional. By default, throttling is scoped to the action and account.

Here is a typical usage of the throttle configuration:

Expand All @@ -2195,12 +2203,30 @@ const App = {
},
operation: {
perform: () => {},
inputFields: [],
inputFields: [{key: 'name', required: true, type: 'string'}],
// overwrites the default, for this action
throttle: {
window: 600,
limit: 5,
key: 'test-key-{{bundle.inputData.name}}',
scope: ['account'],
overrides: [
{
window: 600,
limit: 10,
filter: 'free',
},
{
window: 600,
limit: 100,
filter: 'trial',
},
{
window: 0,
limit: 0,
filter: 'paid',
},
],
},
},
},
Expand Down
32 changes: 29 additions & 3 deletions packages/cli/docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3655,16 +3655,24 @@ <h2 id="adding-throttle-configuration">Adding Throttle Configuration</h2>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p><em>Added in v15.4.0.</em></p><p>When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action&apos;s operation object, the root-level default is overwritten for that action only.</p><p>To throttle an action, you need to set a <code>throttle</code> object with the following variables:</p><ol>
<p><em>Added in v15.4.0.</em></p><p><em>Updated in v15.6.0</em></p><p>When a throttle configuration is set for an action, Zapier uses it to apply throttling when the limit for the timeframe window is exceeded. It can be set at the root level and/or on an action. When set at the root level, it is the default throttle configuration used on each action of the integration. And when set in an action&apos;s operation object, the root-level default is overwritten for that action only. Note that the throttle limit is not shared across actions unless for those with the same key, window, limit, and scope when &quot;action&quot; is not in the scope.</p><p>To throttle an action, you need to set a <code>throttle</code> object with the following variables:</p><ol>
<li><code>window [integer]</code>: The timeframe, in seconds, within which the system tracks the number of invocations for an action. The number of invocations begins at zero at the start of each window.</li>
<li><code>limit [integer]</code>: The maximum number of invocations for an action, allowed within the timeframe window.</li>
<li><code>key [string]</code>: The key to throttle with in combination with the scope. User data provided for the input fields can be used in the key with the use of the curly braces referencing. For example, to access the user data provided for the input field &quot;test_field&quot;, use <code>{{bundle.inputData.test_field}}</code>. Note that a required input field should be referenced to get user data always.</li>
<li><code>scope [array]</code>: The granularity to throttle by. You can set the scope to one or more of the following options;<ul>
<li>&apos;user&apos; - Throttles based on user ids.</li>
<li>&apos;auth&apos; - Throttles based on auth ids.</li>
<li>&apos;account&apos; - Throttles based on account ids for all users under a single account.</li>
<li>&apos;action&apos; - Throttles the action it is set on separately from other actions.</li>
</ul>
</li>
</ol><p>Except for the scope, all throttle variables are required. By default, throttling is scoped to the account.</p><p>Here is a typical usage of the throttle configuration:</p>
<li><code>overrides [array[object]]</code>: &apos;EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.&apos;;<ul>
<li><code>window [integer]</code>: Same description as above.</li>
<li><code>limit [integer]</code>: Same description as above.</li>
<li><code>filter [string]</code>: Account-based attribute to override the throttle by. You can set to one of the following: &quot;free&quot;, &quot;trial&quot;, &quot;paid&quot;. Therefore, the throttle scope would be automatically set to &quot;account&quot; and ONLY the accounts based on the specified filter will have their requests throttled based on the throttle overrides while the rest are throttled based on the original configuration.</li>
</ul>
</li>
</ol><p>Both <code>window</code> and <code>limit</code> are required and others are optional. By default, throttling is scoped to the action and account.</p><p>Here is a typical usage of the throttle configuration:</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-js"><span class="hljs-keyword">const</span> App = {
Expand All @@ -3687,12 +3695,30 @@ <h2 id="adding-throttle-configuration">Adding Throttle Configuration</h2>
},
<span class="hljs-attr">operation</span>: {
<span class="hljs-attr">perform</span>: <span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> {},
<span class="hljs-attr">inputFields</span>: [],
<span class="hljs-attr">inputFields</span>: [{<span class="hljs-attr">key</span>: <span class="hljs-string">&apos;name&apos;</span>, <span class="hljs-attr">required</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">type</span>: <span class="hljs-string">&apos;string&apos;</span>}],
<span class="hljs-comment">// overwrites the default, for this action</span>
<span class="hljs-attr">throttle</span>: {
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">5</span>,
<span class="hljs-attr">key</span>: <span class="hljs-string">&apos;test-key-{{bundle.inputData.name}}&apos;</span>,
<span class="hljs-attr">scope</span>: [<span class="hljs-string">&apos;account&apos;</span>],
<span class="hljs-attr">overrides</span>: [
{
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">10</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;free&apos;</span>,
},
{
<span class="hljs-attr">window</span>: <span class="hljs-number">600</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">100</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;trial&apos;</span>,
},
{
<span class="hljs-attr">window</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">limit</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">filter</span>: <span class="hljs-string">&apos;paid&apos;</span>,
},
],
},
},
},
Expand Down
Loading
Loading