Files
CurrenciCombo/docs/MIGRATION_V1_V2.md
defiQUG f52313e7c6 Enhance ComboHandler and orchestrator functionality with access control and error handling improvements
- Added AccessControl to ComboHandler for role-based access management.
- Implemented gas estimation for plan execution and improved gas limit checks.
- Updated execution and preparation methods to enforce step count limits and role restrictions.
- Enhanced error handling in orchestrator API endpoints with AppError for better validation feedback.
- Integrated request timeout middleware for improved request management.
- Updated Swagger documentation to reflect new API structure and parameters.
2025-11-05 17:55:48 -08:00

794 B

API Migration Guide: v1 → v2

Overview

This guide helps migrate from API v1 to v2.

Breaking Changes

Plans Endpoint

v1: POST /api/plans
v2: POST /api/v2/plans

Changes:

  • Response format updated
  • Additional validation fields
  • New error codes

Execution Endpoint

v1: POST /api/plans/:planId/execute
v2: POST /api/v2/plans/:planId/execute

Changes:

  • Execution response includes additional metadata
  • Webhook events structure updated

Migration Steps

  1. Update base URL to use /api/v2 prefix
  2. Update error handling for new error codes
  3. Update response parsing for new formats
  4. Test thoroughly in staging environment

Timeline

  • v1 Deprecation: 2025-07-01
  • v1 Sunset: 2025-12-31

Last Updated: 2025-01-15