Ruby configuration

Overrides the API-wide api.settings.auto-generate-idempotency-key for this SDK. Set true to attach an idempotency-key header to eligible requests (POST and PUT by default) unless the caller provides one, or false to opt this SDK out when auto-generation is enabled API-wide. Pass an object to customize header-name and methods.

Custom name for the client module. This allows you to customize the module name that wraps the generated client class.

Custom name for the pager class used in paginated endpoints. By default, the generator creates a standard pager class, but you can customize its name to match your SDK’s naming conventions.

Add custom sections to the generated README file. Each section requires a title and content.

1
config:
2
  customReadmeSections:
3
    - title: "Custom integration"
4
      content: "Instructions for custom integration..."
5
    - title: "Advanced usage"
6
      content: "Advanced usage examples for {{ packageName }}"

The content supports template variables like {{ packageName }} that are replaced with actual values during generation.

When enabled, generates mock server (wire) tests to verify that the SDK sends and receives HTTP requests as expected.

Specify additional dependencies to include in the generated SDK’s gemspec. This is useful when you need to add custom gems that your SDK depends on.

Specify additional development dependencies to include in the generated SDK’s Gemfile. These are dependencies used for development and testing but not required by end users.

The default number of retries for failed requests. When not set, the generated SDK uses its own built-in default. SDK users can still override this per-request via request options.

Custom module name for the generated SDK. This sets the top-level Ruby module that wraps all generated code. By default, the module name is derived from the package name in your publish configuration or your organization name.

1
config:
2
  moduleName: MyCustomModule

This generates code like:

1
module MyCustomModule
2
  class Client
3
    # ...
4
  end
5
end

Controls how the offset parameter is interpreted for auto-paginated endpoints.

• item-index: The offset counts individual items (e.g., offset 20 skips the first 20 items).
• page-index: The offset counts pages (e.g., offset 3 skips to page 3).

When enabled, the generated SDK omits the X-Fern-Language, X-Fern-SDK-Name, and X-Fern-SDK-Version headers from HTTP requests.

When enabled, the generated SDK sends a single structured User-Agent header of the form {sdkName}/{version} ({os}; {arch}) {runtime}/{runtimeVersion} (for example, my-sdk/0.0.1 (linux; x86_64) Ruby/3.2.0), carrying SDK, operating system, architecture, and runtime information in place of the default User-Agent and discrete platform headers. A configured user-agent template supplies the leading product token. If omitFernHeaders is enabled, no User-Agent or platform headers are sent and this option has no effect.

When enabled, the generated client accepts an optional app_info keyword of the shape { name:, version:, comment: }, which appends a {name}/{version} ({comment}) product token to the User-Agent header so an application built on the SDK can identify itself to the API. The application passes a required name plus an optional version and comment; omitted or blank values are dropped from the token. An explicit User-Agent header takes precedence, and omitFernHeaders suppresses the header entirely.

1
app_info: { name: "partner-app", version: "3.1.0", comment: "+https://partner.example" }
2
# User-Agent: my-sdk/0.0.1 (linux; x86_64) Ruby/3.2.0 partner-app/3.1.0 (+https://partner.example)

Paths to files that will be auto-loaded when the gem is required. This is useful for including custom integrations or extensions that should be loaded automatically.

1
config:
2
  requirePaths:
3
    - custom_integration
4
    - sentry_integration

This will load lib/<gem>/custom_integration.rb and lib/<gem>/sentry_integration.rb when the gem is required.