I’m trying to set the description to a REST API Gateway through serverless.yml, using serverless version 2.72.3
I couldn’t find anything here https://www.serverless.com/framework/docs/providers/aws/events/apigateway
I’ve also tried:
provider:
apiGateway:
description: Your custom description
but nothing happens after deploying to AWS, the description is not changing (other changes are working)
EDIT: Thanks to Albert Marrero answer I now understand why it isn’t working, but not how to make it work. Attached Screenshot to clarify which description I’d like to change (API Gateway description, not stage description)
2
Answers
According to this guide, this setting for the description for the API Gateway stage deployment. Check your description in each of your stages
You have to define
ApiGatewayRestApi
resource by your self (Ref), then you can add description.And remember to update
provider
to use your defined api gateway if you already config http event for some lambda functionsList of ApiGateway properties