Zuplo Changelog

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

This release enhances the Dev Portal with improved real-time updates, better authentication support, and a streamlined Zuplo integration experience. Key improvements include automatic sidebar refresh when API schemas change, enhanced Auth0 and OpenID authentication capabilities, and a new command-line option for Zuplo users.

New Features 🎉#

• Automatic sidebar refresh on API schema changes #910 - The Dev Portal sidebar now automatically refreshes when your API schema is modified, providing a seamless real-time experience without requiring manual page refreshes.

• Streamlined Zuplo integration #914 - Simplified the Zuplo integration process by replacing manual configuration with automated environment setup and build status monitoring, making it easier to integrate the Dev Portal with your Zuplo API gateway.

• Enhanced empty state experience for API documentation #922 - Added user-friendly empty state screens that display helpful guidance when OpenAPI documents lack operations or schema tags, improving the developer experience when working with incomplete documentation.

• New --zuplo command-line option #925 - Introduced a dedicated CLI flag that enables Zuplo-specific features with automatic diagnostics logging, simplifying the developer workflow for Zuplo users.

Bug Fixes 🐛#

• Auth0 scope configuration support #929 - Fixed an issue preventing custom authentication scopes configuration for Auth0 providers. You can now specify custom scopes like scopes: ["my-scope"] for more flexible authentication setups.

• OpenID authentication with base paths #927 - Resolved authentication issues when applications use custom base paths (e.g., /docs), ensuring OpenID authentication works correctly across different deployment configurations.

• Improved URL-based OpenAPI documentation routing #936 - Enhanced OpenAPI documentation generation with better tag parameter handling and streamlined route creation, making the system more robust and maintainable.

• Enhanced schema management architecture #924 - Refactored the schema management system with a dedicated SchemaManager class, featuring improved file watching and cache-busting capabilities for more efficient schema processing.

Dependency Updates 📦#

• Updated syntax highlighting library (shiki) from 3.2.1 to 3.2.2 #900
• Updated nx-dependencies group with 4 updates #930
• Updated postcss from 8.4.49 to 8.5.3 #933
• Updated @radix-ui/react-toggle from 1.1.3 to 1.1.6 #931
• Updated eslint-dependencies group with 4 updates #935

New Contributors#

• @ashipilov made their first contribution in #929

This release brings enhanced accessibility features and improved API schema processing capabilities to the Dev Portal. Notable improvements include better Windows keyboard shortcut support, dynamic sidebar padding for improved readability, and expanded API schema transformation options.

New Features 🎉#

• Enhanced keyboard shortcut support for Windows users #893
• Added API schema processors for advanced schema transformations and customizations #890

Bug Fixes 🐛#

• Improved sidebar visibility by adding dynamic padding to prevent content from being obscured by gradients #896
• Resolved duplicate sidebar key issue that could cause navigation problems #898
• Updated lucide-react icons to the latest version for consistent iconography #895

Dependency Updates 📦#

• Updated remark-mdx-frontmatter from 5.0.0 to 5.1.0 #902
• Updated graphql-yoga from 5.13.2 to 5.13.3 #901
• Updated nx-dependencies group with 3 package updates #899
• General package upgrades for improved security and performance #904