Speakeasy Generation Config File
Speakeasy generation configuration file. Read more at https://www.speakeasy.com/docs/speakeasy-reference/generation/gen-yaml
| Type | object |
|---|---|
| File match |
**/.speakeasy/gen.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/speakeasy-generation-config-file/latest.json |
| Source | https://raw.githubusercontent.com/speakeasy-api/sdk-gen-config/main/schemas/gen.config.schema.json |
Validate with Lintel
npx @lintel/lintel checkProperties
The version of the configuration file
Generation configuration
18 nested properties
Authentication configuration
3 nested properties
Enables hoisting of operation-level security schemes to global level when no global security is defined
Enables support for OAuth2 client credentials grant type
Enables support for OAuth2 resource owner password credentials grant type
The base URL of the server. This value will be used if global servers are not defined in the spec.
Deduplicates errors that have the same schema
Dev container configuration
2 nested properties
Whether dev containers are enabled
Path to the schema file for the dev container
Fixes applied to the SDK generation
8 nested properties
Prevents component-level x-speakeasy-name-override from affecting parent names when referencing schema via $ref or hoisting allOf extensions
Enables name resolution fixes from December 2023
Enables name resolution fixes from February 2025
Enables parameter ordering fixes from February 2024
Enables request and response component naming fixes from February 2024
Enables fixes and refactoring for security that were introduced in February 2025
Enables fixes that mean that when a component is used in both 2XX and 4XX responses, only the top level component will be duplicated to the errors scope as opposed to the entire component tree
Fixes component naming when the same schema is referenced in multiple places within nested structures, ensuring consistent naming based on the original component definition
Generates an overload if generator detects that the request body field 'stream: true' is used for client intent to request 'text/event-stream' response
Maintains the order of parameters and fields in the OpenAPI specification
Mock server generation configuration
1 nested properties
Disables the code generation of the mock server target
Configures whether user edits to generated SDKs persist across regenerations
2 nested properties
When true (default), runs an initial compile pass to normalize pristine content. Set to false when generated SDK doesn't compile but you still want persistent edits.
Enables preservation of user edits across SDK regenerations. Set to 'never' to disable prompts.
The name of the field to use for the request body in generated SDKs
Schema processing configuration
1 nested properties
Controls how allOf schemas are merged
Generated name of the root SDK class
Enables access to the SDK configuration from hooks
Skips the automatic addition of an error suffix to error types
Test generation configuration
3 nested properties
Enables generation of new tests for any new operations in the OpenAPI specification
Enables generation of tests
Skip asserting that the client got the same response bodies returned by the mock server
Configuration for usage snippets
3 nested properties
Controls how optional properties are rendered in usage snippets
Controls how the SDK initialization is depicted in usage snippets
Controls which server is shown in usage snippets. If unset, no server will be shown. If an integer, it will be used as the server index. Otherwise, it will look for a matching server ID.
Use class names for array fields instead of the child's schema type
Controls how SDK versions are determined. 'automatic' (default) bumps versions based on changes, 'manual' uses the version in gen.yaml as-is.
Definitions
Authentication configuration
Enables hoisting of operation-level security schemes to global level when no global security is defined
Enables support for OAuth2 client credentials grant type
Enables support for OAuth2 resource owner password credentials grant type
Dev container configuration
Whether dev containers are enabled
Path to the schema file for the dev container
Fixes applied to the SDK generation
Prevents component-level x-speakeasy-name-override from affecting parent names when referencing schema via $ref or hoisting allOf extensions
Enables name resolution fixes from December 2023
Enables name resolution fixes from February 2025
Enables parameter ordering fixes from February 2024
Enables request and response component naming fixes from February 2024
Enables fixes and refactoring for security that were introduced in February 2025
Enables fixes that mean that when a component is used in both 2XX and 4XX responses, only the top level component will be duplicated to the errors scope as opposed to the entire component tree
Fixes component naming when the same schema is referenced in multiple places within nested structures, ensuring consistent naming based on the original component definition
Generation configuration
Authentication configuration
3 nested properties
Enables hoisting of operation-level security schemes to global level when no global security is defined
Enables support for OAuth2 client credentials grant type
Enables support for OAuth2 resource owner password credentials grant type
The base URL of the server. This value will be used if global servers are not defined in the spec.
Deduplicates errors that have the same schema
Dev container configuration
2 nested properties
Whether dev containers are enabled
Path to the schema file for the dev container
Fixes applied to the SDK generation
8 nested properties
Prevents component-level x-speakeasy-name-override from affecting parent names when referencing schema via $ref or hoisting allOf extensions
Enables name resolution fixes from December 2023
Enables name resolution fixes from February 2025
Enables parameter ordering fixes from February 2024
Enables request and response component naming fixes from February 2024
Enables fixes and refactoring for security that were introduced in February 2025
Enables fixes that mean that when a component is used in both 2XX and 4XX responses, only the top level component will be duplicated to the errors scope as opposed to the entire component tree
Fixes component naming when the same schema is referenced in multiple places within nested structures, ensuring consistent naming based on the original component definition
Generates an overload if generator detects that the request body field 'stream: true' is used for client intent to request 'text/event-stream' response
Maintains the order of parameters and fields in the OpenAPI specification
Mock server generation configuration
1 nested properties
Disables the code generation of the mock server target
Configures whether user edits to generated SDKs persist across regenerations
2 nested properties
When true (default), runs an initial compile pass to normalize pristine content. Set to false when generated SDK doesn't compile but you still want persistent edits.
Enables preservation of user edits across SDK regenerations. Set to 'never' to disable prompts.
The name of the field to use for the request body in generated SDKs
Schema processing configuration
1 nested properties
Controls how allOf schemas are merged
Generated name of the root SDK class
Enables access to the SDK configuration from hooks
Skips the automatic addition of an error suffix to error types
Test generation configuration
3 nested properties
Enables generation of new tests for any new operations in the OpenAPI specification
Enables generation of tests
Skip asserting that the client got the same response bodies returned by the mock server
Configuration for usage snippets
3 nested properties
Controls how optional properties are rendered in usage snippets
Controls how the SDK initialization is depicted in usage snippets
Controls which server is shown in usage snippets. If unset, no server will be shown. If an integer, it will be used as the server index. Otherwise, it will look for a matching server ID.
Use class names for array fields instead of the child's schema type
Controls how SDK versions are determined. 'automatic' (default) bumps versions based on changes, 'manual' uses the version in gen.yaml as-is.
Language-specific SDK configuration
SDK version
Mock server generation configuration
Disables the code generation of the mock server target
Configures whether user edits to generated SDKs persist across regenerations
When true (default), runs an initial compile pass to normalize pristine content. Set to false when generated SDK doesn't compile but you still want persistent edits.
Enables preservation of user edits across SDK regenerations. Set to 'never' to disable prompts.
Schema processing configuration
Controls how allOf schemas are merged
Controls which server is shown in usage snippets. If unset, no server will be shown. If an integer, it will be used as the server index. Otherwise, it will look for a matching server ID.
Test generation configuration
Enables generation of new tests for any new operations in the OpenAPI specification
Enables generation of tests
Skip asserting that the client got the same response bodies returned by the mock server
Configuration for usage snippets
Controls how optional properties are rendered in usage snippets
Controls how the SDK initialization is depicted in usage snippets
Controls which server is shown in usage snippets. If unset, no server will be shown. If an integer, it will be used as the server index. Otherwise, it will look for a matching server ID.