Skip to content
This repository has been archived by the owner on Jul 23, 2021. It is now read-only.

Using Models and Documentation in one file #126

Open
lucas-rudd opened this issue Oct 22, 2019 · 0 comments
Open

Using Models and Documentation in one file #126

lucas-rudd opened this issue Oct 22, 2019 · 0 comments

Comments

@lucas-rudd
Copy link

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant