Zuplo Changelog
We release improvements, new features, and fixes daily. Follow along here to see the most important updates.
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 📦#
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
This release introduces new logging integrations with New Relic and Splunk, fixes several issues with the CLI and runtime, and improves documentation for fine-grained authorization policies.
New Features 🎉#
- Added New Relic logging and metrics plugin - Enable comprehensive observability by sending logs and metrics to New Relic for monitoring and analysis
- Added Splunk log transport - Stream your API logs directly to Splunk for centralized log management and analysis
Bug Fixes 🐛#
- Fixed excessive error logging in rate limiter - Rate limiter failures no longer generate unnecessary error logs, reducing log noise
- Fixed typos in CLI OpenAPI merge functionality - Corrected command syntax issues that prevented proper OpenAPI specification merging
- Fixed tunnel list command authentication - The
tunnel-listcommand now properly supports the updated authentication mechanism - Fixed AWS Lambda handler query string handling - Multi-value query strings are now correctly parsed and passed to Lambda functions
Documentation 📚#
- Added documentation for Fine-Grained Authorization (FGA) policy - Learn how to implement fine-grained access control using OpenFGA
Other Changes 🔄#
- Added build script to Zudoku template - The developer portal template now includes a build script for easier deployment
- Fixed API quota documentation - Updated quota configuration examples and clarified usage limits
The Zuplo Developer portal is the easiest way to create beautiful documentation for your API - today, it gets even better with a new API Playground. The API Playground allows your users to immediately call your API without leaving the browser. Try it out now on Zuplo's API docs or create your own in the Portal.
We announced last week during Supabase Week that the Zuplo Developer portal now supports Supabase Authentication in addition to OpenID based auth. Supabase developers can now use their custom hosted Supabase login experience to authenticate users to their API docs hosted by Zuplo. For full instructions see the documentation.
Dev Portal Performance#
Over the past several weeks we have worked on improving the overall performance of the Developer Portal and we are happy to report that the results have been meaningful. For most real use loads of the API page, the content loads in about a second. Larger APIs (i.e. with larger OpenAPI documents) may experience a bit longer load time, but we plan to address that soon.
Custom pages should load almost instantly now as we have optimized serving them from our edge CDN.
Overall you should see much snappier UI in the developer portal. We have more work to do - in particular for customers with larger OpenAPI documents, but we hope you will be happy with the recent improvements.
Over the past several weeks we have worked on improving the overall performance of the Developer Portal and we are happy to report that the results have been meaningful. For most real use loads of the API page, the content loads in about a second. Larger APIs (i.e. with larger OpenAPI documents) may experience a bit longer load time, but we plan to address that soon.
Custom pages should load almost instantly now as we have optimized serving them from our edge CDN.
Overall you should see much snappier UI in the developer portal. We have more work to do - in particular for customers with larger OpenAPI documents, but we hope you will be happy with the recent improvements.