Exporting API Gateway HTTP APIs as OpenAPI 3.0

[ewbankkit]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

You can now export an OpenAPI 3.0 compliant API definition file from HTTP APIs in Amazon API Gateway.
It would be useful to be able to then import the definition as the body attribute of an aws_api_gateway_rest_api resource.

New or Affected Resource(s)

Best implemented as a new data source?

• aws_apigatewayv2_api_body

Potential Terraform Configuration

data "aws_apigatewayv2_api_body" "example" {
  api_id = "${aws_apigatewayv2_api.example.id}"

  output_type   = "JSON"
  specification = "OAS30"
}

References

Announcement.
Developer guide.

Requires AWS SDK v1.30.10:

• Update module aws/aws-sdk-go to v1.30.12 #12715

Related:

• Amazon API Gateway HTTP APIs #11148

[github-actions]

This functionality has been released in v3.74.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. Thank you!

[github-actions]

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.