Automated Code Samples & Overlay Management in Speakeasy Studio!
Blog post from Speakeasy
Speakeasy has introduced two significant updates to improve API workflows: Automated Code Sample URLs and Overlay Management in Speakeasy Studio. The Automated Code Sample URLs feature provides a stable, auto-updating link for SDK code samples that ensures documentation remains synchronized with the latest API changes. This feature utilizes the x-codeSamples extension in OpenAPI specifications and is supported by popular documentation platforms such as Scalar, Bump.sh, Mintlify, Redocly, and ReadMe. Overlay Management allows users to edit OpenAPI specifications directly in Speakeasy Studio, with changes saved as overlays, preserving the original source files. This update simplifies the process of modifying specs and integrates automatic SDK regeneration to reflect changes immediately. Additionally, various platform bug fixes and feature enhancements have been implemented across different programming languages, including Go, TypeScript, Python, Terraform, and PHP, to improve functionality and resolve issues like outdated examples and incorrect status code handling.