serverless-aws-alias icon indicating copy to clipboard operation
serverless-aws-alias copied to clipboard

Show APIG information on serverless info

Open HyperBrain opened this issue 8 years ago • 3 comments
trafficstars

Additionally to function information, the plugin should display APIG information of the deployed APIG stages when invoked by serverless info.

HyperBrain avatar Mar 03 '17 10:03 HyperBrain

Currently the APIG deployed stage details cannot be shown. It seems that there is a bug in AWS::APIGateway::getDeployment() that prevents the return of the apiSummary object, which we need here. As soon as they've fixed the issue the functionality can be enabled again.

HyperBrain avatar Mar 03 '17 10:03 HyperBrain

AWS confirmed that there is a bug in the ApiGateway REST API. So I keep this as "blocked" until I receive further information.

HyperBrain avatar Mar 07 '17 10:03 HyperBrain

Got an answer. There is a workaround to get the API summary information on a deployed APIG stage.

Meanwhile you can consider trying to manually retrieve the apisummary by using the 'embed' query parameter. If you pass in "embed=apisummary" in the request, you will get the apisummary part as well.

The parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary. Please see [1] to know more about this.

[1] : http://docs.aws.amazon.com/apigateway/api-reference/link-relation/deployment-by-id/

Nevertheless this would mean that there has to be a HTTP client in the implementation which would just be temporary. Maybe the client in the AWS SDK can be used directly here, to not add additional dependencies.

HyperBrain avatar Mar 20 '17 08:03 HyperBrain