We’ve enhanced the overall usability and accessibility of the API portal, making it faster to navigate and easier to consume across different workflows.
92 posts tagged with "Improvement"
View All TagsPre-Release Notice: Improved Title Generation in SDK Documentation
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.
Enhanced SDK Documentation for Enumeration
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.
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 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
Enhanced Configuration Management for API Endpoint Pages
We've redesigned the configuration section on API endpoint pages to bring essential settings front and center. The new "Configurations" panel consolidates environment selection, Base URLs, and authentication inputs into a single, intuitive interface—eliminating the need to hunt through hidden menus and popups.
Improved HTTP Client Injection in Python SDKs
The Python SDKs now support interface-driven HTTP client injection and direct use of a requests.Session instance, improving developer experience, flexibility and alignment with other SDKs.
Introducing Masked Sensitive Fields for Code Samples
We've enhanced the security and privacy of your API documentation by automatically masking sensitive fields such as API keys, tokens, and credentials in code samples and the authentication section. Sensitive values are now hidden during display but remain accessible when copied, reducing the risk of accidental exposure.