For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Slack communityLog inBook a demo
  • Overview
    • Introduction
    • Quickstart
    • Capabilities
    • Customer Showcase
  • Generators
      • Quickstart
      • Configuration
      • Changelog
      • Publishing to RubyGems
    • MCP Server
  • Deep Dives
    • Customize Method Names
    • Setup local SDK previews
    • Configure Global Headers
    • Configure Auto-Pagination
    • Configure Idempotency
    • Filter Your Endpoints (Audiences)
  • Reference
    • generators.yml
LogoLogo
Slack communityLog inBook a demo
On this page
  • August 5, 2024
  • 0.8.2
  • July 22, 2024
  • 0.8.1
  • July 3, 2024
  • 0.8.0
  • July 1, 2024
  • 0.8.0-rc0
  • June 13, 2024
  • 0.7.0-rc0
  • May 27, 2024
  • 0.6.3
  • May 17, 2024
  • 0.6.2
  • April 9, 2024
  • 0.5.0-rc0
  • April 8, 2024
  • 0.7.0-rc5
  • 0.7.0-rc4
  • 0.7.0-rc3
  • 0.7.0-rc2
  • 0.7.0-rc1
  • 0.6.1
  • 0.6.1-rc0
  • 0.6.0-rc1
  • 0.6.0-rc0
  • 0.5.0-rc2
  • 0.4.0
  • March 22, 2024
  • 0.3.3
  • 0.1.0-rc0
  • 0.0.6
  • 0.0.5
  • 0.0.4
  • 0.0.3
  • 0.0.2
GeneratorsRuby

Changelog

August 5, 2024
August 5, 2024

0.8.2

(fix): The generated endpoint functions no long include object utilities such as _field_set or additional_properties.


July 22, 2024
July 22, 2024

July 3, 2024
July 3, 2024

0.8.0

(fix): Date snippets now wrap their examples in quotation marks to correctly use .parse


July 1, 2024
July 1, 2024

0.8.0-rc0

(feat): allow users to specify additional dependencies and dev dependencies for Ruby SDKs.


June 13, 2024
June 13, 2024

May 27, 2024
May 27, 2024

0.6.3

(feat): Generated SDK snippets now leverage the full function module path.


May 17, 2024
May 17, 2024

0.6.2

(internal): The generator now uses the latest FDR SDK


April 9, 2024
April 9, 2024

April 8, 2024
April 8, 2024

March 22, 2024
March 22, 2024

Older posts

Next
Built with

0.8.1

(fix): Address serialization issues within iterable types

What’s been fixed

  • Nested hash types are recursively resolved in from_json such that they come back as true hashes, as opposed to structs
  • Pass through additional params from request options even if the original request did not have those types of params (ex: query parameters)

0.7.0-rc0

(feat): Introduce automatic token refresh for OAuth credentials

What’s new

  • The Ruby SDK now generates an OAuth client to automate token refresh.

What’s been fixed

  • The Ruby SDK now no longer requires users specify literals in method signatures

0.5.0-rc0

(feat): The generated SDK now includes a rakefile to run any tests prefixed with test_ in the test directory

What’s new

  • Consumers of the SDK can now pass in a base URL override into the root client, as well as the request’s RequestOptions

What’s been fixed

  • This PR includes a number of typing annotation and cleanliness/QOL fixes.

0.7.0-rc5

(feat): additional fix for the same issue within 0.7.0-rc4 (regression introduced within the 0.7.0 RCs where the token prefix was dropped from requests).

0.7.0-rc4

(feat): fixes regression introduced within the 0.7.0 RCs where the token prefix was dropped from requests.

0.7.0-rc3

(fix): Module references are now consistent throughout the generated SDK, this was a regression in the previous release.

0.7.0-rc2

(feat): the ruby generator now nests types under a type module to avoid naming conflicts, this is behind a configuration flag

0.7.0-rc1

(feat): Address serialization issues within iterable types

What’s been fixed

  • nested loops leverage different variable names to deconflict
  • nested loops do not call to_json prior to the subsequent loop

0.6.1

(internal): Release Generator

0.6.1-rc0

(internal): Improve logging within the Ruby generator

0.6.0-rc1

(fix): fix regression where sometimes the parsed_json variable would not be instantiated, and so there’d be a nil ref in the generated code

0.6.0-rc0

(feat): Introduce code snippets and examples for Ruby SDKs

0.5.0-rc2

(fix): Call JSON.parse prior to iterating through an iterable response

0.4.0

(feat): The generated SDK now includes a rakefile to run any tests prefixed with test_ in the test directory

What’s new

  • The generators now create a rakefile to run any tests prefixed with test_ in the test directory. A step is also added to CI to run these test. The dummy test now running also provides a sanity check on the health of the build of the gem, even if no tests are added given the gem is imported.

0.3.3

(internal): Leverage shared generator notification and config parsing logic.

0.1.0-rc0

(chore): Loosen the Faraday dependencies within the generated SDKs

What’s changed

  • loosen the Faraday dependencies within the generated SDKs, now we are supporting Faraday 1.x, while continuing to support the same upperbound (specifically supporting the latest major version as well).
  • release a minor version as the Ruby generator is now being used in beta!

0.0.6

(feat): license files are now specified within the gem config if they are provided

0.0.5

(fix): Address parsing issues within the SDK

What’s been fixed

  • Syntactic error in block parameter usage: we now ensure block parameters are the final parameter for functions
  • Add properties to subpackages: previously properties on subpackages were not being exposed
  • Ensure optional properties in from_json are only parsed if present

0.0.4

(fix): ensures files are written at the gem name path over client name, and addresses string escaping on one of the Fern headers

0.0.3

(fix): addresses a number of typos and other issues previously contained within the generation code

0.0.2

(feat): Support rubygems output type within generators.yml