Files
adastra_api/docs/POST_MIGRATION_CHECKLIST.md
T
julien 097e11be1b docs: add backend documentation files
Reference guides (Sequelize model methods, Swagger) and migration reports
from the MongoDB-to-MySQL and domain-based route structure migrations.
2026-04-26 16:54:56 +02:00

2.1 KiB

Post-Migration Update Checklist

Files Updated by Script ✓

  • Swagger YAML files (/api/v1 → /api/skydive, etc.)
  • Postman collection and environment files
  • API routes structure (new domains created)

Manual Verification Required

1. Test API Endpoints

npm run local                    # Start the server
# In another terminal:
curl http://localhost:3200/api-docs   # Check Swagger UI

2. Verify Routes

  • GET /api/skydive/jumps
  • GET /api/cms/articles
  • GET /api/herowars/clans
  • Other domain-specific endpoints

3. Frontend Updates Required (if applicable)

  • Update Angular environment files (environment.ts, environment.development.ts, etc.)
  • Replace all API calls from /api/v1, /api/v2, /api/v3 to new domains
  • Update service layer URLs
  • Update HTTP interceptors if needed

4. Documentation Updates

  • Update README.md with new API structure
  • Update API documentation (if any)
  • Update deployment/infrastructure docs
  • Update team wiki/documentation

5. CI/CD Pipeline (if applicable)

  • Update build/deployment scripts referencing v1/v2/v3
  • Update any health checks pointing to old paths
  • Update monitoring/alerting rules

6. Client Applications

  • Update all client libraries/SDKs
  • Update mobile app API endpoints
  • Update third-party integrations

7. Database/Caching (if applicable)

  • Clear any cached references to old endpoints
  • Update API documentation in databases
  • Check for hardcoded URLs in configuration

Git Operations

# View the migration commits
git log --oneline -5

# If rollback needed:
git revert <commit-hash>

# Push changes
git push origin develop

Optional: Cleanup Old Directories

# After thorough testing, remove old v1/v2/v3 directories:
rm -rf src/routes/api/v1
rm -rf src/routes/api/v2
rm -rf src/routes/api/v3
git add -A
git commit -m "chore: remove old v1/v2/v3 route directories"

Rollback Procedure

If issues arise, rollback with:

git reset --hard HEAD~2  # Adjust commit count if needed

Document generated: 2026-04-23T22:48:52.497Z