Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
zapier-platform-schema
Advanced tools
zapier-platform-schema - npm Package Compare versions
Comparing version 0.3.1 to 0.3.2
| # `zapier-platform-schema` Generated Documentation | ||
| This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `0.3.1`. | ||
| This is automatically generated by the `npm run docs` command in `zapier-platform-schema` version `0.3.2`. | ||
@@ -66,3 +66,3 @@ > Note: Generally you wouldn't be using these docs to build an app from scratch - they are better used for debugging a specific error you might run across. | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AppSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AppSchema.js) | ||
| * **Source Code** - [lib/schemas/AppSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AppSchema.js) | ||
@@ -97,3 +97,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationBasicConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationBasicConfigSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationBasicConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationBasicConfigSchema.js) | ||
@@ -110,3 +110,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationCustomConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationCustomConfigSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationCustomConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationCustomConfigSchema.js) | ||
@@ -123,3 +123,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationDigestConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationDigestConfigSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationDigestConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationDigestConfigSchema.js) | ||
@@ -136,3 +136,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationOAuth2ConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationOAuth2ConfigSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationOAuth2ConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationOAuth2ConfigSchema.js) | ||
@@ -161,3 +161,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationSchema.js) | ||
@@ -189,3 +189,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/AuthenticationSessionConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/AuthenticationSessionConfigSchema.js) | ||
| * **Source Code** - [lib/schemas/AuthenticationSessionConfigSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/AuthenticationSessionConfigSchema.js) | ||
@@ -210,3 +210,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/BasicDisplaySchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/BasicDisplaySchema.js) | ||
| * **Source Code** - [lib/schemas/BasicDisplaySchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/BasicDisplaySchema.js) | ||
@@ -251,3 +251,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/BasicHookOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/BasicHookOperationSchema.js) | ||
| * **Source Code** - [lib/schemas/BasicHookOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/BasicHookOperationSchema.js) | ||
@@ -279,3 +279,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/BasicOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/BasicOperationSchema.js) | ||
| * **Source Code** - [lib/schemas/BasicOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/BasicOperationSchema.js) | ||
@@ -304,3 +304,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/BasicPollingOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/BasicPollingOperationSchema.js) | ||
| * **Source Code** - [lib/schemas/BasicPollingOperationSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/BasicPollingOperationSchema.js) | ||
@@ -331,3 +331,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/DynamicFieldsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/DynamicFieldsSchema.js) | ||
| * **Source Code** - [lib/schemas/DynamicFieldsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/DynamicFieldsSchema.js) | ||
@@ -356,3 +356,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/FieldSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/FieldSchema.js) | ||
| * **Source Code** - [lib/schemas/FieldSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/FieldSchema.js) | ||
@@ -404,3 +404,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/FieldsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/FieldsSchema.js) | ||
| * **Source Code** - [lib/schemas/FieldsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/FieldsSchema.js) | ||
@@ -417,3 +417,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/FlatObjectSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/FlatObjectSchema.js) | ||
| * **Source Code** - [lib/schemas/FlatObjectSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/FlatObjectSchema.js) | ||
@@ -455,3 +455,3 @@ #### Examples | ||
| * **Pattern** - `^\$func\$\d+\$[tf]\$$` | ||
| * **Source Code** - [lib/schemas/FunctionSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/FunctionSchema.js) | ||
| * **Source Code** - [lib/schemas/FunctionSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/FunctionSchema.js) | ||
@@ -473,3 +473,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/HydratorsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/HydratorsSchema.js) | ||
| * **Source Code** - [lib/schemas/HydratorsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/HydratorsSchema.js) | ||
@@ -494,3 +494,3 @@ | ||
| * **Pattern** - `^[a-zA-Z]+[a-zA-Z0-9_]*$` | ||
| * **Source Code** - [lib/schemas/KeySchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/KeySchema.js) | ||
| * **Source Code** - [lib/schemas/KeySchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/KeySchema.js) | ||
@@ -507,3 +507,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/MiddlewaresSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/MiddlewaresSchema.js) | ||
| * **Source Code** - [lib/schemas/MiddlewaresSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/MiddlewaresSchema.js) | ||
@@ -520,3 +520,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/RedirectRequestSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/RedirectRequestSchema.js) | ||
| * **Source Code** - [lib/schemas/RedirectRequestSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/RedirectRequestSchema.js) | ||
@@ -543,3 +543,3 @@ | ||
| * **Pattern** - `^[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)?(\.[a-zA-Z0-9_]+)?$` | ||
| * **Source Code** - [lib/schemas/RefResourceSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/RefResourceSchema.js) | ||
| * **Source Code** - [lib/schemas/RefResourceSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/RefResourceSchema.js) | ||
@@ -566,3 +566,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/RequestSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/RequestSchema.js) | ||
| * **Source Code** - [lib/schemas/RequestSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/RequestSchema.js) | ||
@@ -592,3 +592,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodCreateSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodCreateSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodCreateSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodCreateSchema.js) | ||
@@ -614,3 +614,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodGetSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodGetSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodGetSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodGetSchema.js) | ||
@@ -636,3 +636,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodHookSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodHookSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodHookSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodHookSchema.js) | ||
@@ -658,3 +658,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodListSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodListSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodListSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodListSchema.js) | ||
@@ -680,3 +680,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodSearchOrCreateSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodSearchOrCreateSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodSearchOrCreateSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodSearchOrCreateSchema.js) | ||
@@ -702,3 +702,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceMethodSearchSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceMethodSearchSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceMethodSearchSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceMethodSearchSchema.js) | ||
@@ -724,3 +724,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourceSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourceSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourceSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourceSchema.js) | ||
@@ -754,3 +754,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResourcesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResourcesSchema.js) | ||
| * **Source Code** - [lib/schemas/ResourcesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResourcesSchema.js) | ||
@@ -775,3 +775,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/ResultsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/ResultsSchema.js) | ||
| * **Source Code** - [lib/schemas/ResultsSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/ResultsSchema.js) | ||
@@ -788,3 +788,3 @@ ----- | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/SearchSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/SearchSchema.js) | ||
| * **Source Code** - [lib/schemas/SearchSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/SearchSchema.js) | ||
@@ -812,3 +812,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/SearchesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/SearchesSchema.js) | ||
| * **Source Code** - [lib/schemas/SearchesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/SearchesSchema.js) | ||
@@ -833,3 +833,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/TriggerSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/TriggerSchema.js) | ||
| * **Source Code** - [lib/schemas/TriggerSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/TriggerSchema.js) | ||
@@ -857,3 +857,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/TriggersSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/TriggersSchema.js) | ||
| * **Source Code** - [lib/schemas/TriggersSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/TriggersSchema.js) | ||
@@ -878,3 +878,3 @@ | ||
| * **Pattern** - `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$` | ||
| * **Source Code** - [lib/schemas/VersionSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/VersionSchema.js) | ||
| * **Source Code** - [lib/schemas/VersionSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/VersionSchema.js) | ||
@@ -906,3 +906,3 @@ #### Examples | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/WriteSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/WriteSchema.js) | ||
| * **Source Code** - [lib/schemas/WriteSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/WriteSchema.js) | ||
@@ -930,3 +930,3 @@ | ||
| * **Pattern** - _n/a_ | ||
| * **Source Code** - [lib/schemas/WritesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.1/lib/schemas/WritesSchema.js) | ||
| * **Source Code** - [lib/schemas/WritesSchema.js](https://github.com/zapier/zapier-platform-schema/blob/v0.3.2/lib/schemas/WritesSchema.js) | ||
@@ -933,0 +933,0 @@ |
| { | ||
| "version": "0.3.1", | ||
| "version": "0.3.2", | ||
| "schemas": { | ||
@@ -4,0 +4,0 @@ "AppSchema": { |
| { | ||
| "name": "zapier-platform-schema", | ||
| "version": "0.3.1", | ||
| "version": "0.3.2", | ||
| "description": "An example app for the Zapier platform.", | ||
@@ -5,0 +5,0 @@ "repository": "zapier/zapier-platform-schema", |
@@ -5,51 +5,2 @@ # Schema For Zapier Platform | ||
| 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: | ||
| ```bash | ||
| brew install nvm | ||
| nvm install 4.3.2 | ||
| nvm use 4.3.2 | ||
| ``` | ||
| ### Run Tests | ||
| ```bash | ||
| git git@github.com: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: | ||
| ```bash | ||
| # 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 | ||
| ``` | ||
| [Visit the CLI for basic temporary documentation.](https://www.npmjs.com/package/zapier-platform-cli) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-1.07%
126707
- Number of lines in readme file
- decreased by-89.09%
6
No dependency changes