AWS integration with Swagger does not seem to consider basePath

[arichiardi]

Terraform Version

Terraform v0.11.7

Affected Resource(s)

• aws_api_gateway_rest_api

Terraform Configuration Files

resource "aws_api_gateway_rest_api" "rest_api" {
  name        = "${local.full_prefix}-ep-cloud-api"
  description = "${local.api_title}"
  body        = "${data.template_file.swagger_template.rendered}"
}

...swagger...
 "basePath": "prod",
 "schemes": [
    "https"
  ],
...

Expected Behavior

In the AWS Api Gateway I see:

Auth: NONE
ARN: arn:aws:execute-api:region:accountId:apiId/*/POST/my-endpoint

But I think I should see:

ARN: arn:aws:execute-api:region:accountId:apiId/*/POST/prod/my-endpoint

where the prod is read from the Swagger's basePath, according to https://swagger.io/docs/specification/2-0/api-host-and-base-path.

Actual Behavior

What actually happened?

Steps to Reproduce

Try a swagger.json with basePath set.

Important Factoids

There are workarounds I think, still worth signaling.

[bflad]

Hi @arichiardi 👋 Sorry you're running into trouble here. Does Swagger's basePath work with the AWS CLI? If not, you might want to open an AWS support case.

[arichiardi]

Oh so are you just sending the json to them? I thought terraform was doing the parsing.

[bflad]

Correct, we just upload the JSON to the API:

https://github.com/terraform-providers/terraform-provider-aws/blob/master/aws/resource_aws_api_gateway_rest_api.go#L113-L123

Given this looks like broken functionality of the API Gateway API, I'm going to close this issue for now but do not hesitate to reply back if there's something amiss with the provider handling here.

[arichiardi]

Perfect thank you

[mattetherton]

I also encountered this issue and was able to find a work around by adding the basePath to each individual path.

e,g
"paths": { "/v1/example": {

However, according to the AWS CLI it is possible for the basePath to actually have an effect by using a parameter.

aws apigateway import-rest-api --parameters basepath=prepend --body

For details: https://forums.aws.amazon.com/thread.jspa?messageID=885830&tstart=0

@bflad would you mind reviewing?

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

[ghost]

This has been released in version 3.24.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!