serverless-operations / serverless-operations/serverless-step-functions

Support Request Validation API Gateway Feature

Open
#243 0 comments 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: api-gateway enhancement help wanted
Dominant language
JavaScript
Stars
1k
Forks
220
PR merge metrics
No merged PRs in 30d

Description

This is a Feature Proposal

Description

The API Gateway Request Validation is now supported by Serverless framework:

functions:
  create-something:
    handler: functions/create-something.handler
    events:
      - http:
          path: ${self:custom.version}/things
          method: post
          request:
            schema:
              application/json: ${file(thing.schema.json)}

However, seems the plugin does not support when trying to add the same configuration inside of an event:

stepFunctions:
  stateMachines:
    create-things:
      events:
        - http:
            path: ${self:custom.version}/things
            method: post
            request:
              schema:
                application/json: ${file(thing.schema.json)}

Additional Data

  • Serverless Framework Core Version you're using: latest
  • The Plugin Version you're using: latest
  • Operating System: N/A
  • Stack Trace: N/A
  • Provider Error messages: N/A

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the configuration in the issue with a Step Functions state machine HTTP event and compare it with the working Serverless Framework function event. Trace the plugin's event handling and existing API Gateway tests, if present. Done means the request schema configuration is accepted for the state machine event and produces the expected API Gateway validation behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript
Domain
api, cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.