Zuplo Changelog

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

This release brings significant improvements to the Dev Portal documentation experience with enhanced navigation, better visual indicators, and a comprehensive schema overview system. Key highlights include the addition of pagination for large documentation sets, optional request body indicators, and an improved schema browsing experience.

New Features 🎉#

Enhanced Documentation Navigation

• Added pagination to OpenAPI documentation pages with smooth loading transitions using a subtle progress bar instead of full-page spinners #849

Comprehensive Schema Management

• Introduced a new schema overview page that displays a complete list of all API schemas, making it easier to browse and discover available data structures #855
• Enhanced schema documentation by displaying examples and default values directly in the schema overview to help developers understand real-world usage #859

Improved Request Documentation

• Added visual badges to clearly indicate when request bodies are optional in API endpoint documentation #858

Bug Fixes 🐛#

UI Improvements

• Fixed catalog sidebar incorrectly appearing on API documentation pages, creating a cleaner browsing experience #857

Dependency Updates 📦#

• Updated autoprefixer from 10.4.20 to 10.4.21 #852
• Updated @types/estree from 1.0.6 to 1.0.7 #850
• Updated nx-dependencies group with 3 package updates #853
• Updated Next.js from 15.2.3 to 15.2.4 #861

This release focuses on enhancing authentication capabilities, improving developer experience, and providing better control over search and documentation features. Key improvements include new authentication events, customizable API examples, enhanced search functionality, and better SEO control.

New Features 🎉#

Enhanced API Example Transformation
Added support for custom transformation of operation examples in OpenAPI documentation. Developers can now use a new transformOperationExamples hook to customize how API examples are displayed and processed for both request and response sections. #836

Authentication State Broadcasting
Introduced an "auth" event in the Dev Portal context that broadcasts authentication state changes throughout the application. This improvement enables better state management by allowing other components to react to authentication changes more effectively. #845

Improved Authentication Provider Interface
Added a new signRequest method to authentication providers, centralizing request signing logic within authentication providers. This refactoring improves modularity and separation of concerns by moving responsibility for signing requests from direct header setting to a dedicated method. #846

Context-Aware Search Filtering
Enhanced search functionality by passing authentication and context data to the Pagefind search filter. This makes search results more contextual and enables better search experiences across different authentication states. #847

Bug Fixes 🐛#

Improved Anchor Scrolling
Fixed reliability issues with initial anchor scroll behavior when navigating to hash links. The update includes improved scrolling logic and a MutationObserver to handle initial scroll conditions after component mounting and page loads. #842

Other Changes 🔄#

Canonical URL Configuration
Added a new top-level canonicalUrl configuration option, replacing client-side generation of canonical URLs. This change provides explicit control over canonical URL configuration and prevents preview URLs from potentially being crawled by search engines, ensuring they don't compete with production pages. #841