Zuplo Changelog

This release brings significant improvements to the Dev Portal with enhanced customization capabilities, better user experience features, and important infrastructure upgrades. Notable additions include a new API Key management UI, improved OpenAPI playground functionality, and enhanced slot system extensibility. Please note that this release includes breaking changes related to the slot system and Tailwind CSS upgrade.

Breaking Changes 🛠#

Extended Slot System - #1048
The slot system has been completely refactored and extended to provide more flexibility and customization options. Projects currently using slots will need to update their slot configuration or usage to match the new behavior. The enhanced system offers improved performance and better integration capabilities. Please refer to the updated slot documentation for migration guidance.

Tailwind CSS v4 Upgrade - #981
Upgraded to Tailwind CSS v4, bringing improved performance and new utility classes. This change primarily affects users who utilize custom class names in custom pages or MDX components—these class names may require updates to align with the new Tailwind utility syntax. For most users, the migration should be straightforward. For detailed migration guidance, see the official Tailwind upgrade guide.

Automatic Logo Base Path Resolution
Logo path handling has been improved to automatically resolve base paths. Previously, logo URLs required manual base path prepending, but this is now handled automatically by the system, simplifying configuration and reducing potential errors.

New Features 🎉#

Enhanced API Operation Interface - #1035
Moved operation tabs into card layouts for improved visual organization and better user experience when navigating through API operations.

Simplified Authentication Architecture - #1047
Converted AuthProviders to regular plugins, streamlining the authentication system and making it more consistent with the overall plugin architecture.

Improved OpenAPI Playground Experience - #1065
The API playground now displays schema.default values, providing developers with better context and examples when testing API endpoints.

API Key Management UI - #827
Introduced a comprehensive API Key management interface, allowing users to create, manage, and monitor their API keys directly within the Dev Portal.

Enhanced Navigation - #1076
Added anchor link icons for headings, improving navigation and making it easier to share direct links to specific sections.

Improved Sidebar Usability - #1075
Implemented tooltips for truncated sidebar items, ensuring full text is always accessible even when space is limited.

Bug Fixes 🐛#

Development Experience Improvements - #1038, #1043, #1067
Fixed multiple issues with development configuration reloading, including more reliable file change detection based on modification time and simplified reload mechanisms.

Enhanced Schema Management - #1039
Added proper metadata to schema list pages, improving SEO and providing better context for documentation navigation.

Visual and Layout Fixes - #1063, #1083
Resolved various layout styling issues and fixed code block overflow problems in callouts and admonitions.

Plugin System Enhancements - #1064
Exported authentication plugin types for better TypeScript support and plugin development.

OpenAPI Processing Improvements - #1066, #1068
Improved error handling for mergeAllOf operations and removed unnecessary radio buttons from submit forms in the OpenAPI interface.

Playground Caching Fixes - #1070, #1072
Disabled inappropriate caching for playground mutations and requests to ensure accurate testing results.

Build System Improvements - #1069
Enhanced handling of multiple bundled CSS entries for better build reliability.

Code Syntax Highlighting - #1080
Fixed syntax highlighting copy functionality and empty line handling for better code display.

Markdown Processing - #1081
Restored rehype-raw functionality for proper HTML processing in markdown content.

Documentation 📚#

Configuration Documentation - #1040
Fixed frontmatter sidebar_icon property documentation to ensure proper icon configuration.

Developer Experience 🔄#

Enhanced Hook System - #1073
Exported hooks from zudoku/hooks for better developer experience and easier integration.

Dependency Updates 📦#

Updated multiple dependencies including:

• pnpm/action-setup to v4 - #1049
• @radix-ui/react-scroll-area to v1.2.9 - #1052
• @radix-ui/react-slot to v1.2.3 - #1051
• @radix-ui/react-slider to v1.3.5 - #1053
• Nx dependencies group with 4 updates - #1050

---

For complete technical details and additional changes, view the full release notes on GitHub.

You can now set a custom domain for both your Zuplo-powered Dev Portal and your API.

To get started, log into Zuplo and open the project you want to configure. Navigate to Settings > Custom Domain, then click Add Custom Domain.

Next, choose the deployment branch you want to associate with the domain, and select whether it's for the API Gateway or the Dev Portal.

Once complete, you'll be provided with the DNS configuration details needed to correctly point your custom domain to the Dev Portal.

For more information see our documentation on custom domains.

This release focuses on improving the Dev Portal's schema handling, syntax highlighting capabilities, and overall user experience. Key improvements include enhanced OpenAPI schema processing with better support for allOf merging, an upgraded syntax highlighter for improved code display, and several important bug fixes for UI elements and schema parsing.

New Features 🎉#

• Enhanced schema consistency: Improved handling of allOf schemas for more consistent OpenAPI schema merging and display. This ensures that complex schemas with multiple inheritance patterns are rendered accurately in the Dev Portal. #1002

• Upgraded syntax highlighting: Switched to Shiki syntax highlighter to provide better code highlighting performance and more accurate syntax highlighting across different programming languages in documentation and examples. #961

Bug Fixes 🐛#

• Improved visual consistency: Fixed border color styling for horizontal rule (<hr>) elements in prose content to ensure proper visual consistency across the Dev Portal interface. #1006

• Node.js compatibility: Updated minimum Node.js version requirements to ensure compatibility with the latest features and security updates. #1015

• OpenAPI schema parsing: Resolved issues with circular schema references that could cause infinite loops or rendering failures when processing complex OpenAPI specifications. #1008

• Authentication UI improvements: Fixed incorrect labels in the identity dialog to improve user experience during authentication flows. #1007

Documentation 📚#

• Page configuration guidance: Added comprehensive documentation for the page configuration options, providing developers with clear instructions on how to customize Dev Portal pages. #1004

Dependency Updates 📦#

• Updated @apidevtools/json-schema-ref-parser from 12.0.1 to 12.0.2 #1014
• Updated @radix-ui/react-toggle from 1.1.6 to 1.1.8 #1013
• Updated @radix-ui/react-radio-group from 1.2.4 to 1.3.6 #1012
• Updated @radix-ui/react-accordion from 1.2.4 to 1.2.10 #1011
• Updated ESLint dependencies to latest versions #1010

This release includes an important fix for authentication redirect functionality in the Dev Portal. Users will now experience proper redirection behavior after signing up or signing in.

Breaking Changes 🛠#

Authentication Redirect Configuration Fix

The redirectToAfterSignUp and redirectToAfterSignIn configuration options now function correctly. This fix ensures that users are properly redirected to their intended destination after completing authentication flows. The update includes URL normalization logic and standardized callback path handling across all supported authentication providers (OpenID, Auth0, and Clerk). #997

This release brings significant improvements to OpenAPI schema support and example generation in the Dev Portal. Key highlights include enhanced support for OpenAPI 3.1 features like constant values and additional properties, improved schema example generation, and important bug fixes for better schema rendering.

New Features 🎉#

• OpenAPI 3.1 Constant Support: Added comprehensive support for const declarations in OpenAPI 3.1 schemas, including single string constants, multiple string constants, and array constants. This enhancement improves support for annotated enumerations and makes schema definitions more precise. #968

• Enhanced Schema Example Generation: Improved the accuracy and usefulness of automatically generated schema examples by adding support for const values, format specifications, and *Of schema constructs. This makes the generated examples more meaningful and representative of actual API responses. #972

• Additional Properties Support: Implemented support for the additionalProperties attribute in OpenAPI schemas. This enhancement allows for more flexible schema definitions with custom fields and improves the rendering of object and array types in the Dev Portal. #980

Bug Fixes 🐛#

• Standalone Build Configuration: Fixed an issue with the standalone build process by properly unsetting the ZUPLO_BUILD_CONFIG environment variable in the Vite configuration, ensuring cleaner standalone deployments. #978

• AllOf Schema Example Generation: Resolved a bug where allOf schema example generation was incorrectly returning an array instead of an object. This fix ensures that complex schema compositions are properly represented in generated examples. #975

Dependency Updates 📦#

• Updated @vitejs/plugin-react from version 4.3.4 to 4.4.1 for improved React integration and performance. #946

Other Changes 🔄#

• Fixed a broken documentation link to improve the overall documentation experience. #976

New Contributors#

• @markrzen made their first contribution in #968

This release introduces improved syntax highlighting capabilities for Dev Portal documentation, enhancing the developer experience when viewing code examples and API documentation.

New Features 🎉#

Enhanced Syntax Highlighting

• Upgraded to Shiki syntax highlighter for improved code block rendering in #937
  • Provides server-side rendering (SSR) support for better performance
  • Adds customizable highlighting with transformer support and line highlighting features
  • Enables modern syntax highlighting for a wider range of programming languages
  • Improves visual consistency and readability of code examples in Dev Portal documentation