Skip to main content

Pre-Release Notice: Improved Title Generation in SDK Documentation

· 2 min read

This release enhances SDK documentation title generation from your OpenAPI specifications. We now apply smarter casing rules to endpoint titles and model names. You'll see improved handling of prepositions, acronyms, and any words you've defined in the DoNotSplitWords list.

note

This is a prerelease changelog. This change will take effect in an upcoming release.

What’s Updated​

1. Normalized casing for prepositions​

Prepositions are now lowercased when generating endpoint titles from OpenAPI operationId and model titles from schema names.

paths:
  /subscriptions/{subscriptionId}/coupons:
    delete:
      operationId: removeCouponFromSubscription

Remove Coupon from Subscription

2. Improved acronym splitting​

The handling of acronyms and alphanumeric tokens has been enhanced, producing more accurate splits when generating titles from OpenAPI schema names and operationId.

components:
  schemas:
    "AddressConfig IPv4":
      type: object

Address Config IP V4

Potential breaking change

Improved acronym splitting may change the titles of some endpoints and models in your SDK documentation. If you have links pointing to those generated titles, you may need to update them after regenerating your SDK documentation.

3. Preserved casing for do-not-split words​

Terms defined in the DoNotSplitWords list now retain the exact casing from your OpenAPI schema names when generating model titles.

Example configuration:

info:
  x-codegen-settings:
    DoNotSplitWords:
      - ideal
components:
  schemas:
    iDEAL:
      type: object

iDEAL

Impact​

Titles for endpoints and models now appear more natural and consistent in SDK documentation, accurately reflecting intended naming while correctly handling prepositions, acronyms, and words defined in theDoNotsplitWords list.