List of Speakeasy Extensions
| Extension | Description | Docs |
|---|---|---|
x-speakeasy-name-override | Use it globally to change method names or in-line to change the name of a method, parameter, or class. | Full Docs |
x-speakeasy-group | Allows you to define custom namespaces when adding this property to any operation in your OpenAPI spec. If added, the tags for that method will be ignored and the value of x-speakeasy-group will define the namespace for that method instead. | Full Docs |
x-speakeasy-ignore | Exclude certain methods from your SDK with this extension. | Full Docs |
x-speakeasy-enums | Use this extension to control generated enum members by providing alternative names for each value in the enum field. | Full Docs |
x-speakeasy-enum-format | Customize how the enum type is generated for the schema, either enum for a native enum type or union for a union of values. | Full Docs |
x-speakeasy-retries | Enable retries globally or on a per-request basis. A backoff strategy is applied to specified status codes. | Full Docs |
x-speakeasy-pagination | Customize offset-based or cursor-based pagination rules for each API operation with this property. | Full Docs |
x-speakeasy-usage-example | Feature a method in your SDK's README.md by adding this property to a method. | Full Docs |
x-speakeasy-example | The OpenAPI specification doesn't allow example values for securityscheme property. Using this extension overcomes this limitation. | Full Docs |
x-speakeasy-docs | Configure comments that only show up in the SDK for a single language. | Full Docs |
x-speakeasy-globals | Define parameters that can be configured globally on the main SDK instance and populated automatically for any operations that use them. | Full Docs |
x-speakeasy-globals-hidden | Define parameters that can be configured globally on the main SDK instance but are not shown in the matching method's signature. | Full Docs |
x-speakeasy-errors | Apply this extension at the paths, path item, or operation level of the document to override the default error-handling behavior of the SDKs. | Full Docs |
x-speakeasy-error-message | Used to mark a field in an error response as the field containing the error message to use. | Full Docs |
x-speakeasy-server-id | Enable users to pick a server when instantiating the SDK. Use this extension to define an ID for each server in the servers array in the OpenAPI spec. | Full Docs |
x-speakeasy-deprecation-message | Allows you to add a message to deprecated operations, parameters, and schemas. | Full Docs |
x-speakeasy-deprecation-replacement | Allows you to specify an alternate operation to use in place of a deprecated operation. | Full Docs |
x-speakeasy-type-override | Use this to override the type of a schema to force it to be handled as an any type to accept arbitrary data. | Full Docs |
x-speakeasy-max-method-params | Allows you to set the maximum number of parameters that can be passed to a method. If the number of parameters exceeds this value, a request object will be used instead. | Full Docs |
Using x-speakeasy-extension-rewrite you can map any extension from the wider OpenAPI ecosystem or another vendor to the equivalent Speakeasy extension. This allows you to use your existing OpenAPI spec without needing to make changes to it if possible.
openapi: 3.1.0info: title: My API version: 1.0.0x-speakeasy-extension-rewrite: x-speakeasy-enums: x-enum-varnames # Maps x-enum-varnames used by the OSS generator to x-speakeasy-enums which has the same functionality
Terraform Specific Extensions
| Terraform Extensions | Description | Docs |
|---|---|---|
x-speakeasy-entity | Map API entities to Terraform resources by annotating objects in your OpenAPI spec as entities in the Terraform provider. | Full Docs |
x-speakeasy-entity-operation | Specify CRUD operations for API endpoints to map to Terraform resources, such as create, read, update, or delete operations. | Full Docs |
x-speakeasy-name-override | Remap API properties to Terraform attribute names while keeping API data handling intact. | Full Docs |
x-speakeasy-param-sensitive | Hide sensitive properties from Terraform console output for security purposes. | Full Docs |
x-speakeasy-terraform-ignore | Exclude properties from Terraform state management by using this extension. | Full Docs |
x-speakeasy-type-override | Allows the conversion of an attribute to a JSON string, accommodating dynamic structures in Terraform configurations. | Full Docs |
x-speakeasy-plan-validators | Add custom validation logic to Terraform plan operations to ensure configurations meet predefined criteria before execution. | Full Docs |
x-speakeasy-plan-modifiers | Add custom plan modification logic to Terraform plan operations for advanced default values or resource replacement logic. | Full Docs |
x-speakeasy-entity-version | Specify the version of a Terraform resource to support state migrations for breaking changes. | Full Docs |
x-speakeasy-conflicts-with | Indicate conflicting properties to prevent incompatible combinations in Terraform configurations. | Full Docs |
x-speakeasy-param-readonly | Mark properties as read-only in Terraform, preventing modifications by the user. | Full Docs |
x-speakeasy-param-optional | Force a property to be optional, overriding the required attribute in JSON Schema specifications. | Full Docs |
x-speakeasy-param-force-new | Force resource recreation in Terraform when certain property values change. | Full Docs |
x-speakeasy-terraform-plan-only | Ensure that only values from the Terraform plan are used during updates, overriding prior state or default values. | Full Docs |