Skip to Content
DocumentationSpeakeasyGeneration ConfigRuby Configuration

Ruby Configuration Options

This section details the available configuration options for the Ruby SDK. All configuration is managed in the gen.yaml file under the ruby section.

Version and general configuration

ruby:
  version: 1.2.3
  author: "Author Name"
  packageName: "custom-sdk"
Name
version
Required
true
Default Value
0.0.1
Description
The current version of the SDK.
packageName
Required
true
Default Value
openapi
Description
The name of the package.
author
Required
true
Default Value
Speakeasy
Description
The name of the author of the published package.

Method and parameter management

ruby:
  maxMethodParams: 4
Name
maxMethodParams
Required
false
Default Value
4
Description
Sets the maximum number of parameters before an input object is created.
means input objects are always used.

Module management

ruby:
  module: "OpenApiSdk"
Name
module
Required
true
Default Value
OpenAPISdk
Description
See Docs .

Import management

ruby:
  imports:
    option: "openapi"
    paths:
      callbacks: models/callbacks
      errors: models/errors
      operations: models/operations
      shared: models/components
      webhooks: models/webhooks
Field
option
Required
false
Default Value
"openapi"
Description
Defines the type of import strategy. Typically set to
, indicating that the structure is based on the OpenAPI document.
paths
Required
false
Default Value
{}
Description
Customizes where different parts of the SDK (e.g., callbacks, errors, and operations) will be imported from.

Import paths

Component
callbacks
Default Value
models/callbacks
Description
The directory where callback models will be imported from.
errors
Default Value
models/errors
Description
The directory where error models will be imported from.
operations
Default Value
models/operations
Description
The directory where operation models (i.e., API endpoints) will be imported from.
shared
Default Value
models/components
Description
The directory for shared components, such as reusable schemas, and data models imported from the OpenAPI spec.
webhooks
Default Value
models/webhooks
Description
The directory for webhook models, if the SDK includes support for webhooks.

Forward compatibility

These options control how the SDK handles API evolution, allowing older SDK versions to continue working when APIs add new enum values or union types.

ruby:
  forwardCompatibleEnumsByDefault: true
  unionStrategy: populated-fields
Property
forwardCompatibleEnumsByDefault
Description
Generate enums as open (forward-compatible) by default for response types. Open enums can handle unknown values from the API without breaking. Enums with explicit
extension or special patterns (days of week, months) are not affected.
Type
boolean
Default
true
unionStrategy
Description
Strategy for deserializing union types.
tries each type in order of most required fields first and returns the first valid match.
tries all types and returns the one with the most matching fields (including optional).
Type
string
Default
populated-fields

Last updated on