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.

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

documentation property produces an unrecognized property error #9733

Closed
hernanc opened this issue Jul 12, 2021 · 2 comments
Closed

documentation property produces an unrecognized property error #9733

hernanc opened this issue Jul 12, 2021 · 2 comments
Labels
bug/external Bug on provider side cat/plugin

Comments

@hernanc
Copy link

hernanc commented Jul 12, 2021

Hi there,

I have a function defined like this:

  index:
    name: index
    handler: serverless.handler
    events:
      - http:
          method: get
          path: /
          documentation: ${file(docs/endpoints/index.doc.yml)}
          cors: true

Current behavior
Serverless 2.50.0 produces the following error:

Serverless Error ----------------------------------------

  Configuration error:
       at 'functions.index.events[0].http': unrecognized property 'documentation'

Get Support --------------------------------------------
     Docs:          docs.serverless.com
     Bugs:          github.com/serverless/serverless/issues
     Issues:        forum.serverless.com

  Your Environment Information ---------------------------
     Operating System:          darwin
     Node Version:              12.22.3
     Framework Version:         2.50.0 (local)
     Plugin Version:            5.4.3
     SDK Version:               4.2.3
     Components Version:        3.13.2

Expected behavior:

Serverless understands that property and runs normally like v1 does.

@pgrzesik
Copy link
Contributor

Hello @hernanc - could you please share a full reproducible example? Are you using any plugins? Framework natively does not support such property for that event

@medikoo
Copy link
Contributor

medikoo commented Jul 14, 2021

Closing as duplicate of deliveryhero/serverless-aws-documentation#166

Note, it's likely that we will address this in 1-2 months time on plugin side. Please follow mentioned issue for progress

@medikoo medikoo closed this as completed Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug/external Bug on provider side cat/plugin
Projects
None yet
Development

No branches or pull requests

3 participants