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.
78 lines
2.2 KiB
JavaScript
78 lines
2.2 KiB
JavaScript
'use strict';
|
|
|
|
const makeSchema = require('../utils/makeSchema');
|
|
const { SKIP_KEY } = require('../constants');
|
|
|
|
module.exports = makeSchema({
|
|
id: '/BasicDisplaySchema',
|
|
description: 'Represents user information for a trigger, search, or create.',
|
|
type: 'object',
|
|
properties: {
|
|
label: {
|
|
description:
|
|
'A short label like "New Record" or "Create Record in Project". Optional if `hidden` is true.',
|
|
type: 'string',
|
|
minLength: 2,
|
|
maxLength: 64,
|
|
docAnnotation: {
|
|
required: {
|
|
type: 'replace',
|
|
value: '**yes** (with exceptions, see description)',
|
|
},
|
|
},
|
|
},
|
|
description: {
|
|
description:
|
|
'A description of what this trigger, search, or create does. Optional if `hidden` is true.',
|
|
type: 'string',
|
|
minLength: 1,
|
|
maxLength: 1000,
|
|
docAnnotation: {
|
|
required: {
|
|
type: 'replace',
|
|
value: '**yes** (with exceptions, see description)',
|
|
},
|
|
},
|
|
},
|
|
directions: {
|
|
description:
|
|
'A short blurb that can explain how to get this working. EG: how and where to copy-paste a static hook URL into your application. Only evaluated for static webhooks.',
|
|
type: 'string',
|
|
minLength: 12,
|
|
maxLength: 1000,
|
|
},
|
|
hidden: {
|
|
description: 'Should this operation be unselectable by users?',
|
|
type: 'boolean',
|
|
},
|
|
},
|
|
additionalProperties: false,
|
|
examples: [
|
|
{ hidden: true },
|
|
{ label: 'New Thing', description: 'Gets a new thing for you.' },
|
|
{
|
|
label: 'New Thing',
|
|
description: 'Gets a new thing for you.',
|
|
directions: 'This is how you use the thing.',
|
|
hidden: false,
|
|
},
|
|
],
|
|
antiExamples: [
|
|
{
|
|
[SKIP_KEY]: true, // Cannot validate that description is required if hidden is false
|
|
example: {
|
|
label: 'New Thing',
|
|
hidden: false,
|
|
},
|
|
reason: 'Missing required key: description',
|
|
},
|
|
{
|
|
[SKIP_KEY]: true, // Cannot validate that description is required if hidden is false
|
|
example: {
|
|
description: 'Gets a new thing for you.',
|
|
hidden: false,
|
|
},
|
|
reason: 'Missing required key: label',
|
|
},
|
|
],
|
|
});
|