Skip to main content

July 2024 Release Notes

This month, we’re excited to announce the release of SDK Workflows, revised SDK Documentation, Typescript v2, and the ability to customize operation IDs.

New Releases This Month

SDK Workflows​

With liblab’s SDK Workflows, customers can significantly reduce the complexity of their APIs for end users by combining multiple API steps into a simplified one-step workflow within their SDK. This feature allows customers to provide their end users with a straightforward experience for performing common use cases without needing to learn all the intricacies of the full API functionality.

For detailed instructions, refer to the new tutorial: Combine API Calls Using SDK Workflows

Key Features:​

Simplified API Interactions: Combine multiple API steps into a single workflow in the SDK, reducing complexity for end users and allowing them to get up and running quickly with the API.

Enhanced User Experience: End users can perform common use cases easily without extensive knowledge of the full API as complex API sequences are handled in the background.

Customizable Workflows: Tailor workflows to specific use cases to meet the needs of your end users without having to change the core logic of the API.

Revised SDK Documentation (READMEs)​

We are excited to announce our revised SDK Documentation. With this release, generated SDKs will have consistent, detailed documentation that can easily be integrated into customers' existing API documentation to help end users get up and running quickly with their SDKs.

The new SDK Documentation structure consists of:

Main Level README: Provides an overview of how to get started with the SDK.

Documentation Folder: Contains separate .md files with overviews of every model and service, including code snippet examples for calling every endpoint.

Key Features:​

Inclusive Code Samples: End users can get up and running with the SDK in minutes using code examples demonstrating how to call all endpoints in your API specification.

In Sync with SDK Updates: SDK Documentation is updated with every SDK generation, ensuring documentation is always in sync with the latest API and SDK updates.

Typescript v2 SDK Generator​

The liblab config file has been updated to include Typescript v2 as the default option for customers when generating a Typescript SDK. Typescript v2 includes several enhancements over v1, providing an improved development experience including the integration of Zod, improved SDK Code Snippets for SDK Documentation, and the ability to retry per endpoint.

Key Features:​

Request and Response Validation and JSON Mapping: Using Zod.

Simplified Configuration: Can be applied per endpoint, service, or the entire SDK.

Dev Container and Example Project: For testing and demo purposes.

Improved SDK Documentation (READMEs) and SDK Code Snippets.

Endpoint Customization​

The Endpoint Customization feature allows customers to create custom names for operation IDs, different from what is specified in their API spec, in their generated SDK.

Key Features:​

Seamless User Experience: Customers can specify the path and new operation ID in the liblab config file, which will override the names for operation IDs in all SDK languages generated.

Last updated on