Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

aws cloudwatchEvent event schema #8230

Merged
merged 6 commits into from Sep 15, 2020
Merged

aws cloudwatchEvent event schema #8230

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e0c80c5
aws cloudwatch event schema
Sep 14, 2020
e425e1c
extend schema
Sep 15, 2020
3eb322b
remove schema validation tests
Sep 15, 2020
9fcb264
prettify
Sep 15, 2020
4c53b77
add minLength to name
Sep 15, 2020
5b1f3ad
allow event without any input
thewizarodofoz Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 23 additions & 1 deletion lib/plugins/aws/package/compile/events/cloudWatchEvent/index.js
View file
Open in desktop
Expand Up @@ -11,9 +11,31 @@ class AwsCompileCloudWatchEventEvents {
'package:compileEvents': this.compileCloudWatchEventEvents.bind(this),
};

// TODO: Complete schema, see https://github.com/serverless/serverless/issues/8026
this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'cloudwatchEvent', {
type: 'object',
properties: {
event: { type: 'object' },
input: { type: 'string', maxLength: 8192 },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In implementation we support also object type

inputPath: { type: 'string', maxLength: 256 },
inputTransformer: {
type: 'object',
properties: {
inputPathsMap: { type: 'object' },
inputTemplates: { type: 'string', maxLength: 8192 },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be inputTemplate.

Also we're relying on same configuration in case of eventBridge event. It'll be nice to have both schemas matching.

See:

serverless/lib/plugins/aws/package/compile/events/eventBridge/index.js

Lines 17 to 64 in 6961b62

this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'eventBridge', {
type: 'object',
properties: {
eventBus: { type: 'string', minLength: 1 },
schedule: { pattern: '^(?:cron|rate)\\(.+\\)$' },
pattern: {
type: 'object',
properties: {
'version': {},
'id': {},
'detail-type': {},
'source': {},
'account': {},
'time': {},
'region': {},
'resources': {},
'detail': {},
},
additionalProperties: false,
},
input: { type: 'object' },
inputPath: { type: 'string', minLength: 1, maxLength: 256 },
inputTransformer: {
type: 'object',
properties: {
inputPathsMap: {
type: 'object',
additionalProperties: { type: 'string', minLength: 1 },
},
inputTemplate: { type: 'string', minLength: 1, maxLength: 8192 },
},
required: ['inputTemplate'],
additionalProperties: false,
},
},
allOf: [
{ anyOf: [{ required: ['pattern'] }, { required: ['schedule'] }] },
{
oneOf: [
{ required: [] },
{ required: ['input'] },
{ required: ['inputPath'] },
{ required: ['inputTransformer'] },
],
},
],
});
}

},
required: ['inputTemplates'],
additionalProperties: false,
},
description: { type: 'string', maxLength: 512 },
name: { type: 'string', pattern: '[a-zA-Z0-9-_.]+', maxLength: 64 },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also define minLength

enabled: { type: 'boolean' },
},
oneOf: [
{ required: ['input'] },
{ required: ['inputPath'] },
{ required: ['inputTransformer'] },
Comment on lines +39 to +41
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also add required: [], as technically we do not require any of this options

],
additionalProperties: false,
});
}

Expand Down