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

Full sample? #42

Open
djMax opened this issue Apr 6, 2023 · 0 comments
Open

Full sample? #42

djMax opened this issue Apr 6, 2023 · 0 comments

Comments

@djMax
Copy link

djMax commented Apr 6, 2023

Do you happen to have a sample of a basic "Hello World" type serverless project with this in it? It's unclear where all the docs come from... I just made a project with --template aws-nodejs-typescript and added this to it, but can't get docs to generate:

[serverless-openapi-typescript] Scanning functions for documentation attribute
Environment: darwin, node 16.17.1, framework 3.30.0 (local), plugin 6.2.3, SDK 4.3.2
Docs:        docs.serverless.com
Support:     forum.serverless.com
Bugs:        github.com/serverless/serverless/issues

Error:
Error: Some functions have http events which are not documented:
         hello

        Please add a documentation attribute.
        If you wish to keep the function undocumented, please explicitly set
        documentation: ~
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant