George Lambert
b4150c8250
Compose-ready workspace: packages/zappier (rate card, portal, Stripe), packages/verae-zapier-middleware (timestamp + NATS), packages/verae-zapier (CLI app), vendor/zapier-platform, and research/zapier vendor corpus. Gate 0 structure checks pass. Product code and research are not yet wired.
72 lines
1.9 KiB
JavaScript
72 lines
1.9 KiB
JavaScript
'use strict';
|
|
|
|
const makeSchema = require('../utils/makeSchema');
|
|
|
|
const BasicDisplaySchema = require('./BasicDisplaySchema');
|
|
const BasicActionOperationSchema = require('./BasicActionOperationSchema');
|
|
const KeySchema = require('./KeySchema');
|
|
|
|
module.exports = makeSchema(
|
|
{
|
|
id: '/BulkReadSchema',
|
|
description: 'How will Zapier fetch resources from your application?',
|
|
type: 'object',
|
|
required: ['key', 'noun', 'display', 'operation'],
|
|
properties: {
|
|
key: {
|
|
description: 'A key to uniquely identify a record.',
|
|
$ref: KeySchema.id,
|
|
},
|
|
noun: {
|
|
description:
|
|
'A noun for this read that completes the sentence "reads all of the XXX".',
|
|
type: 'string',
|
|
minLength: 2,
|
|
maxLength: 255,
|
|
},
|
|
display: {
|
|
description: 'Configures the UI for this read bulk.',
|
|
$ref: BasicDisplaySchema.id,
|
|
},
|
|
operation: {
|
|
description: 'Powers the functionality for this read bulk.',
|
|
$ref: BasicActionOperationSchema.id,
|
|
},
|
|
},
|
|
examples: [
|
|
{
|
|
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',
|
|
},
|
|
},
|
|
},
|
|
],
|
|
antiExamples: [
|
|
{
|
|
example: {
|
|
display: {
|
|
label: 'Get User',
|
|
description: 'Retrieve a user.',
|
|
},
|
|
operation: {
|
|
description: 'Define how this search method will work.',
|
|
},
|
|
},
|
|
reason: 'Missing required keys: key and noun',
|
|
},
|
|
],
|
|
additionalProperties: false,
|
|
},
|
|
[KeySchema, BasicDisplaySchema, BasicActionOperationSchema],
|
|
);
|