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

Update shared API instructions #5850

Merged
merged 3 commits into from Feb 20, 2019
Merged

Update shared API instructions #5850

merged 3 commits into from Feb 20, 2019

Conversation

errietta
Copy link
Contributor

@errietta errietta commented Feb 19, 2019

What did you implement:

Closes #XXXXX

Update shared API instructions

The instructions for shared APIs (see the 'easiest and ci/cd friendly' section) would always give me errors such as :

  The CloudFormation template is invalid: Template error: instance of Fn::GetAtt references undefined resource ApiGatewayRestApi

After much googling I found https://forum.serverless.com/t/micro-services-with-shared-api-gateway/6486/2 and the solution proposed (deploying the API and exports as their own service) worked for me.

I thought to update the instructions so more people don't waste hours. Alternatively, if there's a way of making it work the way mentioned, please advise!

How did you implement it:

Just changed the markdown

How can we verify it:

Read the markdown

Todos:

  • Write tests N/A
  • Write documentation
  • Fix linting errors N/A
  • Make sure code coverage hasn't dropped N/A
  • Provide verification config / commands / resources
  • Enable "Allow edits from maintainers" for this PR
  • Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

The instructions for shared APIs would always give me errors such as : 
```
  The CloudFormation template is invalid: Template error: instance of Fn::GetAtt references undefined resource ApiGatewayRestApi
```

After much googling I found https://forum.serverless.com/t/micro-services-with-shared-api-gateway/6486/2 and the solution proposed (deploying the API and exports as their own service) totally worked for me.

I thought to update the instructions so more people don't waste hours. Alternatively, if there's a way of making it work the way mentioned, please advise!
@pmuens pmuens self-assigned this Feb 20, 2019
@pmuens pmuens added this to the 1.39.0 milestone Feb 20, 2019
Copy link
Contributor

@pmuens pmuens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this @errietta 👍

Just looked through this and it makes sense! LGTM :shipit:

@pmuens pmuens merged commit ff8b011 into serverless:master Feb 20, 2019
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

Successfully merging this pull request may close these issues.

None yet

2 participants