Zuplo Changelog

This changelog covers all releases from Monday, 2025-08-11 to Sunday, 2025-08-17.

Summary#

This release focused on improving the stability and reliability of the Dev Portal with multiple bug fixes related to OpenAPI 3.1 support, API reference documentation, and authentication components. Key improvements include better handling of complex schema references, enhanced pagination support, and fixes to API key management. The release also includes updates to several dependencies to ensure security and compatibility.

Features#

No new features were introduced in this release.

Fixes#

• Fixed OpenAPI 3.1 sibling properties in $ref resolution - Improved handling of OpenAPI specifications that use reference objects with sibling properties, ensuring proper schema resolution and documentation generation #1465
• Fixed anyOf schema variants - Resolved issues with anyOf schema handling to properly display all possible schema variations in the API documentation #1469
• Fixed API key secret duplicated elements - Eliminated duplicate elements appearing in API key secret management interfaces #1470
• Fixed x-displayName handling in pagination - Corrected pagination component to properly respect custom display names defined through the x-displayName extension #1471
• Fixed API basename path collision - Resolved conflicts when API basename paths overlap, ensuring proper routing and documentation generation #1473
• Fixed missing response tabs - Restored response tabs that were not displaying correctly in API endpoint documentation #1472

Dependency Updates#

• Updated TypeScript from 5.8.3 to 5.9.2 for improved type checking and performance
• Updated Vitest coverage tools from 3.2.1 to 3.2.4 for better test coverage reporting
• Updated json-schema-to-typescript-lite from 14.1.0 to 15.0.0 for enhanced TypeScript generation
• Updated YAML parser from 2.8.0 to 2.8.1 with bug fixes and improvements
• Updated React and related type definitions for compatibility and performance improvements
• Updated JSON Schema reference parser from 12.0.2 to 14.1.1 with enhanced schema resolution capabilities

This changelog covers all releases from Monday, 2025-08-04 to Sunday, 2025-08-10.

Summary#

This week's updates bring significant improvements to the Dev Portal's developer experience and reliability. Key highlights include the introduction of syntax highlighting language icons for better code readability, new Secret & Value components for enhanced documentation capabilities, and important fixes for catalog hydration and API key management. We've also made a breaking change to treat .md files as plain Markdown for improved compatibility. Additionally, several documentation updates and dependency upgrades ensure the platform remains secure and up-to-date.

Breaking Changes 🛠#

• Markdown file handling update: .md files are now treated as plain Markdown instead of MDX. This change improves compatibility with standard Markdown files and prevents unexpected behavior when importing legacy documentation. #1431

Features 🎉#

• Syntax highlighting language icons: Code blocks now display language-specific icons in the syntax highlighting, making it easier to identify the programming language at a glance. This visual enhancement improves code readability across documentation. #1442

• Secret & Value components: New components for displaying secrets and values in documentation with enhanced security features. These components provide a standardized way to show sensitive information with appropriate masking and copy functionality. #1416

Fixes 🐛#

• Catalog hydration error resolved: Fixed a critical issue where the API catalog would fail to hydrate properly on initial page load, causing content to disappear or display incorrectly. #1432

• Localized dates and prefixes: Resolved issues with mixed locale handling that caused dates and URL prefixes to display inconsistently across different language versions of the documentation. #1439

• Syntax highlighting improvements: Addressed multiple edge cases in syntax highlighting that caused code blocks to render incorrectly or lose formatting in certain scenarios. #1441

• Category titles from OpenAPI: The Dev Portal now correctly uses the x-displayName extension from OpenAPI specifications to display custom category titles, providing better control over API documentation organization. #1437

• Meta tags rendering: Fixed an issue where meta tags for SEO and social sharing were not being properly rendered, improving search engine visibility and social media previews. #1448

• API Key creation button: Resolved a bug where the "Create API Key" button on the API Key Settings page was non-functional, preventing users from generating new API keys through the interface. #1435

Documentation 📚#

• Configuration terminology update: Updated documentation to use consistent terminology, changing references from "page" to "site" in configuration examples for clarity. #1430

• Auth0 integration guide: Enhanced the Auth0 authentication setup instructions to include the required audience parameter configuration, ensuring proper API authorization. #1453

Other Changes 🔄#

• Build performance improvements: Removed Nx Cloud cache to improve build reliability and reduce complexity in the CI/CD pipeline. #1449

• Development environment updates: Updated VS Code workspace settings for Markdown files to ensure consistent formatting across the team. #1452

• Documentation exclusions: Added frontmatter to internal documentation notes to exclude them from the public Zuplo documentation site. #1450

Dependency Updates 📦#

• Updated Motion animation library from 12.23.3 to 12.23.12 #1425
• Updated @testing-library/dom from 10.4.0 to 10.4.1 #1424
• Updated Nx dependencies group (3 updates) #1421, #1443
• Updated Shiki syntax highlighting dependencies (5 updates) #1444, #1456

The Zuplo Legacy Developer Portal will be sunset on November 15, 2025. Please ensure you migrate to the new portal experience before this date.

We're excited to announce the migration to our significantly upgraded Developer Portal experience, powered by Zudoku. This new portal delivers enhanced performance, modern design, and powerful new features for both you and your API consumers.

What's New#

Zudoku-powered Developer Portals offer a significant upgrade, including:

• Sleeker UI with improved layout and navigation
• Redesigned API Playground for more intuitive testing
• Built-in API key management interface
• Plugin-based auth with support for Auth0, Clerk, Supabase, and more
• Powerful custom page development with MDX support
• Install custom modules to extend the functionality of your documentation

You can see all the available features in our Developer Portal documentation.

Migration Required#

You must migrate your Developer Portal by November 15, 2025 when our legacy portal will be discontinued.

Check your migration status:

• Already migrated? Look for a docs folder with zudoku.config.tsx in your Zuplo project
• Need to migrate? No zudoku.config.tsx file means you need to migrate before November 15, 2025.

How to Migrate#

There are two options for migrating your legacy portal to the new experience:

• CLI Migration - Fastest approach using our command line tool
• Manual Migration - Hands-on approach with step-by-step guidance

Our migration guide has all the steps you need to follow.

This changelog covers all releases from Monday, 2025-07-28 to Sunday, 2025-08-03.

Summary#

This week's releases introduce several important improvements to the Dev Portal. The most notable enhancement is the improved rendering of complex OpenAPI schema types (anyOf and oneOf), making API documentation clearer and more intuitive. We've also added support for the x-displayName extension, allowing for better customization of API property names in documentation.

Key fixes include resolving issues with the create-zudoku CLI tool and syntax highlighting errors. We've also improved redirect behavior by switching to JavaScript-based redirects for better reliability. Under the hood, we've migrated to Biome for code formatting and linting, and updated several dependencies including Zod v4, which brings improved TypeScript support.

Features 🎉#

Enhanced Schema Rendering#

• Improved rendering of anyOf and oneOf schema types in API documentation, providing clearer representation of complex schema relationships and making it easier to understand API requirements #1412

Custom Display Names#

• Added support for the x-displayName OpenAPI extension, allowing you to customize how property names appear in your API documentation while maintaining the original schema property names #1396

Fixes 🐛#

CLI Tool Restoration#

• Fixed the create-zudoku command-line tool that was previously broken, restoring the ability to quickly scaffold new Dev Portal projects #1429

Syntax Highlighting#

• Resolved Shiki syntax highlighting errors that were causing code blocks to fail to render properly in documentation #1398

Improved Redirects#

• Replaced HTML meta tag redirects with JavaScript-based redirects for better compatibility and more reliable page navigation #1394

Other Changes 🔄#

Development Improvements#

• Migrated the codebase to use Biome for code formatting and linting, improving development workflow and code consistency #1399
• Added smoke tests for preview publishing to ensure releases are properly validated before deployment #1395
• Updated the managing API keys and identities documentation for clarity #1414
• Removed the changelog trigger workflow #1419

Dependency Updates 📦#

• Updated Zod from v3.25.74 to v4.0.7, bringing improved TypeScript support and performance enhancements #1384
• Updated Rollup from v4.45.0 to v4.46.1 for better build performance #1408, #1402
• Updated GraphQL Yoga from v5.14.0 to v5.15.1 #1372
• Updated @pothos/core from v4.7.0 to v4.8.0 #1401
• Updated lucide-react from v0.525.0 to v0.526.0 #1409
• Updated @types/express from v5.0.2 to v5.0.3 #1410
• Updated esbuild from v0.25.6 to v0.25.8 #1403

This release introduces significant improvements to the Zuplo CLI, rate limiting capabilities, and developer portal experience. Key highlights include a new CLI command for migrating to the redesigned developer portal, enhanced rate limiting with adaptive timeouts, and support for wildcard subdomains in CORS policies.

New Features 🎉#

• New Developer Portal Migration Command - Added zuplo source migrate dev-portal CLI command to help users migrate to the new Zuplo Developer Portal built on the Zudoku framework. This simplifies the transition to the enhanced portal experience.

• Enhanced Rate Limiting with Adaptive Timeouts - The rate limiter policy now supports adaptive and configurable timeouts, providing more flexible control over API rate limiting behavior and improved performance under varying load conditions.

• CLI Project Creation - New CLI command for creating Zuplo projects directly from the command line, streamlining the project setup workflow. See the CLI documentation for usage details.

Bug Fixes 🐛#

• OpenAPI Transpiler Type Handling - Fixed an issue where the OpenAPI transpiler now correctly defaults to "type: object" when properties are defined, ensuring proper schema generation and type safety.

• CLI Tunnel Command Validation - Added missing account argument validation for the create tunnel command in the Zuplo CLI, preventing errors when setting up local development tunnels.

Improvements 🔄#

• Wildcard Subdomain Support for CORS - The CORS policy now supports wildcard subdomains, enabling more flexible cross-origin configurations for APIs serving multiple subdomains or multi-tenant applications.

• Enhanced SSO and MFA Security - Improved security for enterprise accounts by enforcing SSO and MFA requirements, ensuring better access control and compliance with enterprise security policies.

Summary#

This release brings significant improvements to the Dev Portal, including enhanced authentication documentation, better cross-platform compatibility, and a new API key plugin feature. Key highlights include:

• Enhanced Authentication Support: Added comprehensive setup guides for 6 major authentication providers
• Improved Documentation System: Reverted to file-based routing for better performance and added admonition formatting validation
• Cross-Platform Fixes: Resolved Windows path issues for better developer experience
• API Key Enhancement: New ability to access user authentication context during API key creation

New Features 🎉#

ApiKeyPlugin Enhancement (#1360) The API key plugin now passes the auth object into the createKey callback, enabling API key services to access user authentication context during key creation. This allows for more sophisticated key generation workflows that can leverage user-specific data and permissions.

Documentation & Development Experience 📚#

Enhanced Authentication Documentation (#1258) Added comprehensive setup guides for integrating the Dev Portal with 6 major authentication providers:

• Auth0
• Azure AD
• Clerk
• Firebase
• PingFederate
• Supabase

Each guide includes step-by-step configuration instructions and best practices. Learn more about authentication setup →

Documentation Cleanup (#1265) General documentation improvements including formatting consistency and clarity enhancements across multiple pages.

Bug Fixes 🐛#

File-Based Routing Restoration (#1341) Reverted to file-based routing for documentation pages with a new serveAllFiles configuration option. This change improves performance and simplifies the documentation serving architecture.

Cross-Platform Path Resolution (#1357) Fixed a critical issue where Windows file paths (using backslashes) were not properly normalized to POSIX format (forward slashes). This ensures the Dev Portal works correctly across all operating systems.

BuildCheck Environment Type (#1356, #1358) Resolved an issue where precompiled components couldn't access environment-specific configurations. The environment type is now properly passed through the build process, enabling correct behavior in different deployment environments.

Template Link Correction (#1355) Fixed broken links in the Dev Portal template and added proper redirects for renamed configuration options to maintain backward compatibility.

Dependency Updates 📦#

Updated various dependencies to their latest versions for improved security and performance:

• zustand: 5.0.5 → 5.0.6
• @supabase/supabase-js: 2.50.0 → 2.51.0
• Shiki syntax highlighting dependencies (5 packages)
• Build tools: esbuild, fast-glob, ci-info
• Nx workspace dependencies (4 packages)