zapier-platform-schema

Schema For Zapier Platform

This is currently pre-release software! You can fill out https://zapier.typeform.com/to/Z4TZBm if you'd like early access.

This repo has:

• An example examples/definition.json with some triggers, searches and actions.
• A working schema.js (and corresponding lib/schemas/*.js) that can validate the examples/definition.json.
• An exported-schema.json suitable for loading into any other backend that needs validation.

Requirements

Make sure you have Node 4.3.2+. If not, do:

brew install nvm
nvm install 4.3.2
nvm use 4.3.2

Run Tests

git [e-mail]:zapier/zapier-platform-schema.git
cd zapier-platform-schema
npm install
npm test
# also ran in Travis CI

Make Changes or Add More

Open a PR and propose the changes you'd like to make. Be sure to update both files!

This is a living specification - we might come up with more definitions like:

• examples/definition-oauth.json
• examples/definition-search-or-write.json
• etc...

Once we are pretty happy with the collection - we'll be able to kick off a project with some solid foundational examples. That will help us write a core interpreter and a platform SDK and generator.

Releasing a New Version

We've configured the proper npm version behavior with pre/post hooks. This simplifies the publishing flow:

# do not edit package.json, exported-schema.json or docs.md - is automatic!
# be sure to do the same across the other libraries (cli and core)
npm version patch # 1.0.0 -> 1.0.1
npm version minor # 1.0.0 -> 1.1.0
npm version major # 1.0.0 -> 2.0.0