From 062f6abbfe161ffd82d5c1b1653c002561285344 Mon Sep 17 00:00:00 2001 From: SZ-CHENG HUANG Date: Mon, 26 Oct 2020 17:23:13 +0800 Subject: [PATCH 1/2] Face out of the link to Slack. Replace the link to Slack with one to Zapier community --- packages/cli/README-source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cli/README-source.md b/packages/cli/README-source.md index 69205c653..3ac0f8a80 100644 --- a/packages/cli/README-source.md +++ b/packages/cli/README-source.md @@ -1872,4 +1872,4 @@ 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 Slack team here](https://join.slack.com/t/zapier-platform/shared_invite/enQtOTgyMjkzNDU1NjM5LWM1MGQ1YmY5ODgxNmM1NjIzZTk3NjNkMzFlZWExYzU2MDJjNTVmNDEzMWUzYjdlNmMzZGViMzE0YjhlOGIyZDA). +You can get help by either emailing partners@zapier.com or by [joining our developer community here](https://community.zapier.com/developer-discussion-13). From 27ba63a757cc60cb1db9adf078d0213aea3dff7d Mon Sep 17 00:00:00 2001 From: szchenghuang Date: Mon, 26 Oct 2020 17:27:41 +0800 Subject: [PATCH 2/2] Docs generation. --- docs/index.html | 2 +- packages/cli/README.md | 2 +- packages/cli/docs/index.html | 2 +- packages/schema/docs/build/schema.md | 318 +++++++++------------------ 4 files changed, 103 insertions(+), 221 deletions(-) diff --git a/docs/index.html b/docs/index.html index 464686306..11b28b30e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5256,7 +5256,7 @@

Get Help!

-

You can get help by either emailing partners@zapier.com or by joining our Slack team here.

+

You can get help by either emailing partners@zapier.com or by joining our developer community here.

diff --git a/packages/cli/README.md b/packages/cli/README.md index 84cfa999f..26f2ea98f 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -3236,4 +3236,4 @@ 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 Slack team here](https://join.slack.com/t/zapier-platform/shared_invite/enQtOTgyMjkzNDU1NjM5LWM1MGQ1YmY5ODgxNmM1NjIzZTk3NjNkMzFlZWExYzU2MDJjNTVmNDEzMWUzYjdlNmMzZGViMzE0YjhlOGIyZDA). +You can get help by either emailing partners@zapier.com or by [joining our developer community here](https://community.zapier.com/developer-discussion-13). diff --git a/packages/cli/docs/index.html b/packages/cli/docs/index.html index 464686306..11b28b30e 100644 --- a/packages/cli/docs/index.html +++ b/packages/cli/docs/index.html @@ -5256,7 +5256,7 @@

Get Help!

-

You can get help by either emailing partners@zapier.com or by joining our Slack team here.

+

You can get help by either emailing partners@zapier.com or by joining our developer community here.

diff --git a/packages/schema/docs/build/schema.md b/packages/schema/docs/build/schema.md index 0d4abd036..7a56afd17 100644 --- a/packages/schema/docs/build/schema.md +++ b/packages/schema/docs/build/schema.md @@ -340,13 +340,11 @@ Represents user information for a trigger, search, or create. * `{ label: 'New Thing', description: 'Gets a new thing for you.' }` * ``` - { - label: 'New Thing', + { label: 'New Thing', description: 'Gets a new thing for you.', directions: 'This is how you use the thing.', hidden: false, - important: true - } + important: true } ``` #### Anti-Examples @@ -456,24 +454,19 @@ How will Zapier fetch resources from your application? #### Examples * ``` - { - key: 'recipes', + { key: 'recipes', noun: 'Recipes', display: { label: 'Recipes', description: 'A Read that lets Zapier fetch all recipes.' }, - operation: { - perform: '$func$0$f$', - sample: { id: 1, firstName: 'Walter', lastName: 'Sobchak', occupation: 'Bowler' } - } - } + operation: + { perform: '$func$0$f$', + sample: { id: 1, firstName: 'Walter', lastName: 'Sobchak', occupation: 'Bowler' } } } ``` #### Anti-Examples * ``` - { - display: { label: 'Get User', description: 'Retrieve an a user.' }, - operation: { description: 'Define how this search method will work.' } - } + { display: { label: 'Get User', description: 'Retrieve an a user.' }, + operation: { description: 'Define how this search method will work.' } } ``` #### Properties @@ -520,48 +513,38 @@ How will Zapier create a new object? #### Examples * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Create Recipe', description: 'Creates a new recipe.' }, - operation: { perform: '$func$2$f$', sample: { id: 1 } } - } + operation: { perform: '$func$2$f$', sample: { id: 1 } } } ``` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Create Recipe', description: 'Creates a new recipe.' }, - operation: { perform: '$func$2$f$', sample: { id: 1 }, shouldLock: true } - } + operation: { perform: '$func$2$f$', sample: { id: 1 }, shouldLock: true } } ``` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Create Recipe', description: 'Creates a new recipe.', hidden: true }, - operation: { perform: '$func$2$f$' } - } + operation: { perform: '$func$2$f$' } } ``` #### Anti-Examples * `'abc'` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Create Recipe', description: 'Creates a new recipe.' }, - operation: { perform: '$func$2$f$', shouldLock: 'yes' } - } + operation: { perform: '$func$2$f$', shouldLock: 'yes' } } ``` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Create Recipe', description: 'Creates a new recipe.' }, - operation: { perform: '$func$2$f$' } - } + operation: { perform: '$func$2$f$' } } ``` #### Properties @@ -741,12 +724,7 @@ Defines a field an app either needs as input, or gives as output. In addition to * `{ key: 'abc', type: 'loltype' }` * `{ key: 'abc', children: [], helpText: '' }` * `{ key: 'abc', children: [ { key: 'def', children: [] } ] }` -* `{ - key: 'abc', - children: [ - { key: 'def', children: [ { key: 'dhi' } ] } - ] -}` +* `{ key: 'abc', children: [ { key: 'def', children: [ { key: 'dhi' } ] } ] }` * `{ key: 'abc', children: [ '$func$2$f$' ] }` #### Properties @@ -1033,29 +1011,19 @@ How will we find create a specific object given inputs? Will be turned into a cr #### Examples * ``` - { - display: { label: 'Create Tag', description: 'Create a new Tag in your account.' }, - operation: { perform: '$func$2$f$', sample: { id: 1 } } - } + { display: { label: 'Create Tag', description: 'Create a new Tag in your account.' }, + operation: { perform: '$func$2$f$', sample: { id: 1 } } } ``` * ``` - { - display: { - label: 'Create Tag', - description: 'Create a new Tag in your account.', - hidden: true - }, - operation: { perform: '$func$2$f$' } - } + { display: { label: 'Create Tag', description: 'Create a new Tag in your account.', hidden: true }, + operation: { perform: '$func$2$f$' } } ``` #### Anti-Examples * ``` - { - display: { label: 'Create Tag', description: 'Create a new Tag in your account.' }, - operation: { perform: '$func$2$f$' } - } + { display: { label: 'Create Tag', description: 'Create a new Tag in your account.' }, + operation: { perform: '$func$2$f$' } } ``` #### Properties @@ -1080,25 +1048,19 @@ How will we get a single object given a unique identifier/id? #### Examples * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { perform: { url: '$func$0$f$' }, sample: { id: 385, name: 'proactive enable ROI' } } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { perform: { url: '$func$0$f$' }, sample: { id: 385, name: 'proactive enable ROI' } } } ``` * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, - operation: { perform: { url: '$func$0$f$' } } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, + operation: { perform: { url: '$func$0$f$' } } } ``` #### Anti-Examples * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { perform: { url: '$func$0$f$' } } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { perform: { url: '$func$0$f$' } } } ``` #### Properties @@ -1123,29 +1085,19 @@ How will we get notified of new objects? Will be turned into a trigger automatic #### Examples * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { - type: 'hook', - perform: '$func$0$f$', - sample: { id: 385, name: 'proactive enable ROI' } - } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { type: 'hook', perform: '$func$0$f$', sample: { id: 385, name: 'proactive enable ROI' } } } ``` * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, - operation: { type: 'hook', perform: '$func$0$f$' } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, + operation: { type: 'hook', perform: '$func$0$f$' } } ``` #### Anti-Examples * ``` - { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { type: 'hook', perform: '$func$0$f$' } - } + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { type: 'hook', perform: '$func$0$f$' } } ``` #### Properties @@ -1170,38 +1122,24 @@ How will we get a list of new objects? Will be turned into a trigger automatical #### Examples * ``` - { - display: { - label: 'New User', - description: 'Trigger when a new User is created in your account.' - }, - operation: { - perform: { url: 'https://fake-crm.getsandbox.com/users' }, - sample: { id: 49, name: 'Veronica Kuhn', email: 'veronica.kuhn@company.com' } - } - } + { display: { label: 'New User', description: 'Trigger when a new User is created in your account.' }, + operation: + { perform: { url: 'https://fake-crm.getsandbox.com/users' }, + sample: { id: 49, name: 'Veronica Kuhn', email: 'veronica.kuhn@company.com' } } } ``` * ``` - { - display: { - label: 'New User', - description: 'Trigger when a new User is created in your account.', - hidden: true - }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } } - } + { display: + { label: 'New User', + description: 'Trigger when a new User is created in your account.', + hidden: true }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } } } ``` #### Anti-Examples * ``` - { - display: { - label: 'New User', - description: 'Trigger when a new User is created in your account.' - }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } } - } + { display: { label: 'New User', description: 'Trigger when a new User is created in your account.' }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/users' } } } ``` #### Properties @@ -1226,31 +1164,21 @@ How will we find a specific object given filters or search terms? Will be turned #### Examples * ``` - { - display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' }, - operation: { perform: '$func$2$f$', sample: { id: 1 } } - } + { display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' }, + operation: { perform: '$func$2$f$', sample: { id: 1 } } } ``` * ``` - { - display: { - label: 'Find a Recipe', - description: 'Search for recipe by cuisine style.', - hidden: true - }, - operation: { perform: '$func$2$f$' } - } + { display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.', hidden: true }, + operation: { perform: '$func$2$f$' } } ``` #### Anti-Examples * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' }, - operation: { perform: '$func$2$f$' } - } + operation: { perform: '$func$2$f$' } } ``` #### Properties @@ -1275,81 +1203,55 @@ Represents a resource, which will in turn power triggers, searches, or creates. #### Examples * ``` - { - key: 'tag', + { key: 'tag', noun: 'Tag', - get: { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { - perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' }, - sample: { id: 385, name: 'proactive enable ROI' } - } - } - } + get: + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: + { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' }, + sample: { id: 385, name: 'proactive enable ROI' } } } } ``` * ``` - { - key: 'tag', + { key: 'tag', noun: 'Tag', sample: { id: 385, name: 'proactive enable ROI' }, - get: { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } - } - } + get: + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } } } ``` * ``` - { - key: 'tag', + { key: 'tag', noun: 'Tag', - get: { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } - }, - list: { - display: { - label: 'New Tag', - description: 'Trigger when a new Tag is created in your account.' - }, - operation: { - perform: { url: 'https://fake-crm.getsandbox.com/tags' }, - sample: { id: 385, name: 'proactive enable ROI' } - } - } - } + get: + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.', hidden: true }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } }, + list: + { display: { label: 'New Tag', description: 'Trigger when a new Tag is created in your account.' }, + operation: + { perform: { url: 'https://fake-crm.getsandbox.com/tags' }, + sample: { id: 385, name: 'proactive enable ROI' } } } } ``` #### Anti-Examples * ``` - { - key: 'tag', + { key: 'tag', noun: 'Tag', - get: { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } - }, - list: { - display: { - label: 'New Tag', - description: 'Trigger when a new Tag is created in your account.' - }, - operation: { - perform: { url: 'https://fake-crm.getsandbox.com/tags' }, - sample: { id: 385, name: 'proactive enable ROI' } - } - } - } + get: + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } }, + list: + { display: { label: 'New Tag', description: 'Trigger when a new Tag is created in your account.' }, + operation: + { perform: { url: 'https://fake-crm.getsandbox.com/tags' }, + sample: { id: 385, name: 'proactive enable ROI' } } } } ``` * ``` - { - key: 'tag', + { key: 'tag', noun: 'Tag', - get: { - display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, - operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } - } - } + get: + { display: { label: 'Get Tag by ID', description: 'Grab a specific Tag by ID.' }, + operation: { perform: { url: 'https://fake-crm.getsandbox.com/tags/{{inputData.id}}' } } } } ``` #### Properties @@ -1456,36 +1358,26 @@ How will Zapier search for existing objects? #### Examples * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' }, - operation: { perform: '$func$2$f$', sample: { id: 1 } } - } + operation: { perform: '$func$2$f$', sample: { id: 1 } } } ``` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', - display: { - label: 'Find a Recipe', - description: 'Search for recipe by cuisine style.', - hidden: true - }, - operation: { perform: '$func$2$f$' } - } + display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.', hidden: true }, + operation: { perform: '$func$2$f$' } } ``` #### Anti-Examples * `'abc'` * ``` - { - key: 'recipe', + { key: 'recipe', noun: 'Recipe', display: { label: 'Find a Recipe', description: 'Search for recipe by cuisine style.' }, - operation: { perform: '$func$2$f$' } - } + operation: { perform: '$func$2$f$' } } ``` #### Properties @@ -1532,35 +1424,25 @@ How will Zapier get notified of new objects? #### Examples * ``` - { - key: 'new_recipe', + { key: 'new_recipe', noun: 'Recipe', display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' }, - operation: { type: 'polling', perform: '$func$0$f$', sample: { id: 1 } } - } + operation: { type: 'polling', perform: '$func$0$f$', sample: { id: 1 } } } ``` * ``` - { - key: 'new_recipe', + { key: 'new_recipe', noun: 'Recipe', - display: { - label: 'New Recipe', - description: 'Triggers when a new recipe is added.', - hidden: true - }, - operation: { type: 'polling', perform: '$func$0$f$' } - } + display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.', hidden: true }, + operation: { type: 'polling', perform: '$func$0$f$' } } ``` #### Anti-Examples * ``` - { - key: 'new_recipe', + { key: 'new_recipe', noun: 'Recipe', display: { label: 'New Recipe', description: 'Triggers when a new recipe is added.' }, - operation: { perform: '$func$0$f$' } - } + operation: { perform: '$func$0$f$' } } ``` #### Properties