ื“ืœื’ ืœืชื•ื›ืŸ ื”ืจืืฉื™

API Changelog

Track breaking changes and version updates to the Ever Gauzy API.

Versioning Policyโ€‹

The Ever Gauzy API follows semantic versioning. Breaking changes are documented here and announced in release notes.

Latest Changesโ€‹

v0.x โ†’ v1.0 (Upcoming)โ€‹

Breaking Changes:

  • Relation whitelisting enforced on all public endpoints
  • UUID validation added to all ID parameters
  • Deprecated findOneById in favor of findOneByIdString

New Endpoints:

  • POST /api/auth/email/verify/code โ€” email verification
  • GET /api/daily-plan โ€” daily plans
  • GET /api/organization-sprint โ€” sprint management
  • GET /api/comment โ€” comments system
  • GET /api/entity-subscription โ€” subscriptions
  • GET /api/screening-task โ€” screening tasks

Deprecated Endpoints:

  • GET /api/tags/getByName โ†’ use query filters instead

Security Updatesโ€‹

  • Enum-based relation whitelisting on public invoice/estimate endpoints
  • UUIDValidationPipe applied to all :id parameters
  • Rate limiting on authentication endpoints

Migration Guideโ€‹

When upgrading between major versions:

  1. Review breaking changes above
  2. Update API client calls
  3. Test with new validation rules
  4. Check deprecated endpoint usage