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

Warn when custom.documentation does not exist #144

Open
ghost opened this issue Dec 16, 2019 · 0 comments
Open

Warn when custom.documentation does not exist #144

ghost opened this issue Dec 16, 2019 · 0 comments

Comments

@ghost
Copy link

ghost commented Dec 16, 2019

There can be two things that can cause downloadDocumentation to fail which may lead to cryptic errors:

  1. No deploy was done, meaning that the REST API ID won't show up in the CFN stack.
  2. The custom.documentation key wasn't set, meaning that it'll also not show up in the CFN stack.

IMHO, we should error when this key doesn't exist in serverless.yml and downloadDocumentation is called, and additionally mention that you should deploy the docs before calling downloadDocumentation.

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

0 participants