Enhanced SDK documentation for enumeration casing across all supported languages. This update ensures consistent and accurate environment enumeration representation in the Getting Started section for all languages. We also improved enum casing in the model documentation section for Java.
Enhanced SDK Documentation for Collected Parameters
We've enhanced SDK documentation completeness and alignment with the actual implementation for Java, .NET, and Go SDKs. This update includes model documentation for parameter collection classes and updated endpoint documentation that presents collected parameters as unified model references, resulting in clearer and more accurate SDK documentation.
Enhanced Error Handling in Code Samples Across SDKs
We have improved error handling in PHP, TypeScript, Java, .NET, and Go code samples to make it clearer, more consistent, and easier to handle typed errors, while still exposing response metadata like status codes and headers.
Better Readability with Customizable Custom Content Layouts
We've added custom content page layouts to give you better readability and control over how on-page navigation elements are displayed. Choose the layout that works best for your content and readers.
Added Support for Icons in the Developer Portal Sidebar
Sidebar navigation items in the Developer Portal now support icons, helping users scan and navigate documentation more quickly through clear visual cues.
Enhanced API Recipe Completion Flow
We've enhanced API Recipe completions to provide clear success confirmation and guide developers toward their next learning step.
Reimagined API Playground Experience
We've moved the API playground and code samples into a drawer interface that opens on demand. This reduces clutter on endpoint pages, particularly for endpoints with deeply nested fields, and keeps documentation visible while developers explore your API.
Improved Messaging for Docs as Code - Async API
The status endpoint of the Docs as Code - Async API now provides granular error messaging that clearly distinguishes between subscription issues and validation problems, complete with actionable details for faster troubleshooting.
Improved Python SDK Code Quality and Language Alignment
This release delivers comprehensive code quality improvements to our Python SDKs. Generated SDKs now produce Ruff-compatible code that adheres to PEP 8 and PEP 257 style guidelines.
Key outcomes:
- Cleaner, more maintainable SDK code that follows modern Python best practices, with properly formatted docstrings, organized imports, and consistent styling
- CI/CD integration ready with included
ruff.tomlconfiguration for automated linting
The improvements span string literal consistency, import organization, docstring formatting, line length management, and formatter-friendly structure. Where linting rules could potentially impact existing consumer code, they are intentionally bypassed to preserve behavior.
Zero-Downtime Upgrade
- No action required. These improvements maintain full backward compatibility with existing SDK implementations. No breaking changes are included.
- Simply regenerate your Python SDKs to take advantage of these enhancements
Introducing exports Module in TypeScript SDKs
The TypeScript SDK module export changes announced earlier are now live across all generated SDKs. These updates align with modern TypeScript best practices and improve cross-environment compatibility.