Using Models and Documentation in one file
lucas-rudd opened this issue · 0 comments
lucas-rudd commented
We're using a tool called tsoa to generate our swagger documentation using annotations and TypeScript interfaces.
It's a pretty nifty tool, but has some major disadvantages when using this plugin.
In particular, tsoa
generates a single file which contains both models and documentation. Because of this, the following does not work
MyLambda:
timeout: 30
runtime: nodejs10.x
...
events:
- http:
path: /v1/api/myApi
method: get
documentation: ${file(./src/handlers/api/myLambda/doc.yml)}
Does not work, since the documentation cannot find the necessary models.
This is more of a question about how this plugin works, and if there's any technical limitation in CloudFormation that prohibits us from combining the models and documentation in one file.