Release Notes
Stay informed about the latest updates, new features, improvements, and bug fixes for our platform.
Version 3.2.0
Release Date: November 15, 2024
New Features
Advanced Analytics Dashboard
We've introduced a comprehensive analytics dashboard that provides real-time insights into your application performance.
- Custom Metrics: Create and track custom performance indicators
- Visual Reports: Interactive charts and graphs with export capabilities
- Scheduled Reports: Automated report generation and email delivery
- Multi-tenant Support: Isolated analytics per organization
API Rate Limiting
Enhanced API security with configurable rate limiting per endpoint.
| Tier | Requests/Minute | Burst Limit |
|---|---|---|
| Free | 60 | 100 |
| Pro | 600 | 1,000 |
| Enterprise | Unlimited | N/A |
Improvements
- Performance: Reduced API response time by 40% through query optimization
- UI/UX: Redesigned navigation menu for improved accessibility (WCAG 2.1 AA compliant)
- Search: Enhanced search algorithm with fuzzy matching and autocomplete
- Mobile: Optimized mobile experience with responsive layouts
- Documentation: Added 50+ code examples and interactive tutorials
Bug Fixes
- Fixed authentication token refresh issue causing unexpected logouts
- Resolved data export formatting error for CSV files with special characters
- Corrected timezone display inconsistencies in scheduled tasks
- Fixed memory leak in WebSocket connections during extended sessions
- Addressed UI rendering glitch in Safari 16+ for dashboard widgets
Breaking Changes
The deprecated v1 authentication endpoint has been removed. All applications must migrate to v2 authentication.
Migration Required:
- Before (v1)
- After (v2)
Old authentication method (deprecated): POST /api/v1/auth/login
New authentication method: POST /api/v2/auth/authenticate
Dependencies
- Updated React from 18.2.0 to 18.3.1
- Upgraded Node.js minimum version to 18.17.0
- Updated security dependencies
Version 3.1.5
Release Date: October 28, 2024
Bug Fixes
- Hotfix: Critical security patch for authentication bypass vulnerability
- Fixed file upload size validation for files larger than 100MB
- Resolved webhook delivery failures for retry attempts
Security
This release includes important security updates. Immediate upgrade is strongly recommended.
- Patched SQL injection vulnerability in user search functionality
- Enhanced encryption for data at rest
- Implemented additional API request validation
Version 3.1.0
Release Date: October 1, 2024
New Features
Webhook Management
Configure and monitor webhooks directly from the dashboard.
Key Capabilities:
- Real-time webhook event monitoring
- Automatic retry with exponential backoff
- Custom headers and authentication
- Webhook signature verification
Two-Factor Authentication (2FA)
Enhanced account security with TOTP-based 2FA.
- Support for authenticator apps (Google Authenticator, Authy)
- Backup codes for account recovery
- Admin enforcement policies per organization
Improvements
- Backup System: Automated daily backups with 30-day retention
- Notifications: Real-time push notifications for critical events
- API Documentation: Interactive API explorer with live testing
- Localization: Added support for 5 new languages (Spanish, French, German, Japanese, Chinese)
Deprecated
The following features are deprecated and will be removed in version 4.0.0:
- Legacy dashboard (replaced by new analytics dashboard)
- GET /api/v1/users/list endpoint (use GET /api/v2/users instead)
- Environment variable LEGACY_AUTH_MODE
Timeline: These features will be supported until March 31, 2025.
Version 3.0.0
Release Date: September 1, 2024
Major Release
Version 3.0.0 represents a significant milestone with architectural improvements and new capabilities.
New Features
- Microservices Architecture: Redesigned backend for improved scalability
- GraphQL API: New GraphQL endpoint alongside REST API
- Real-time Collaboration: Multi-user editing with conflict resolution
- Advanced Permissions: Role-based access control with custom permissions
- Plugin System: Extensible architecture for third-party integrations
Improvements
- Complete UI redesign with modern design system
- 10x faster database queries through optimized indexing
- Improved error handling with detailed error messages
- Enhanced logging and monitoring capabilities
Breaking Changes
This is a major version update with several breaking changes.
Key Changes:
- Minimum Node.js version increased to 18.x
- Database schema changes (migration scripts provided)
- API endpoint restructuring
- Configuration file format updated
How to Update
Using npm
npm install @example/platform@latest
Using yarn
yarn upgrade @example/platform@latest
Docker
docker pull example/platform:3.2.0
Support and Feedback
- Documentation: docs.example.com
- Community Forum: community.example.com
- Report Issues: GitHub Issues
- Email Support: support@example.com
- Feature Requests: Feature Board
Versioning
We follow Semantic Versioning (SemVer):
- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes
Last updated: November 17, 2024