generate-terraform-provider

You can generate a Terraform provider by annotating your OpenAPI schemas with x-speakeasy-entity and mapping CRUD operations to Terraform methods using the Speakeasy CLI. This automates provider code creation and outputs the necessary gen.yaml configuration.

x-speakeasy-entity is an OpenAPI extension used to tag schemas that should become Terraform resources. By adding this annotation to your spec, you drive automated Terraform resource generation and map API operations to CRUD methods.

Yes, you can prepare generated Terraform provider artifacts for publishing directly to the Terraform Registry. The workflow involves configuring .speakeasy/workflow.yaml to automate builds and releases for your provider package.

You need an OpenAPI 3.x specification, a working Speakeasy CLI installation with authentication configured, and a defined target provider name and package. These prerequisites enable the CLI to generate the workflow config and provider code.

Mapping API CRUD operations to Terraform methods involves using the Speakeasy CLI to process your OpenAPI spec. The CLI reads your x-speakeasy-entity annotations and automatically translates API operations into corresponding Terraform CRUD methods within the provider code.

The best way to automate Terraform provider builds is by creating and tailoring a .speakeasy/workflow.yaml file. This workflow configuration drives automated builds and releases through the Speakeasy CLI, streamlining the path from OpenAPI spec to published provider.