Skip to content

Config schema: Define AWS "websocket" function event properties #8019

Description

@medikoo

Use case description

It'll be nice to have websocket event fully covered by schema validation

Proposed solution

  1. Define schema for following properties at provider level (that's part of Config schema: Define AWS "provider" properties #8022)
  • websocketsApiName
  • websocketsApiRouteSelectionExpression
  • apiGateway.websocketApiId
  • logs.websocket

Should be done directly in: lib/plugins/aws/provider/awsProvider.js:

// TODO: Complete schema, see https://github.com/serverless/serverless/issues/8016
serverless.configSchemaHandler.defineProvider('aws', {

  1. Define schema of all websocket event properties

Should be done directly in: lib/plugins/aws/package/compile/events/websockets/index.js:

// TODO: Complete schema, see https://github.com/serverless/serverless/issues/8019
this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'websocket', {
anyOf: [{ type: 'string' }, { type: 'object' }],
});

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions