37 lines
917 B
Markdown
37 lines
917 B
Markdown
|
# API Deprecation Policy
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
This document outlines the deprecation policy for the ISO-20022 Combo Flow Orchestrator API.
|
||
|
|
|
||
|
|
## Deprecation Timeline
|
||
|
|
|
||
|
|
1. **Announcement**: Deprecated endpoints will be announced 6 months before removal
|
||
|
|
2. **Warning Period**: Deprecation warnings in headers for 3 months
|
||
|
|
3. **Sunset Date**: Full removal after 6 months
|
||
|
|
|
||
|
|
## Deprecation Process
|
||
|
|
|
||
|
|
### Phase 1: Announcement (Month 1-6)
|
||
|
|
- Add deprecation notice to API documentation
|
||
|
|
- Include deprecation headers in API responses
|
||
|
|
- Notify all API consumers
|
||
|
|
|
||
|
|
### Phase 2: Warning Period (Month 4-6)
|
||
|
|
- Continue serving deprecated endpoints
|
||
|
|
- Add migration guides
|
||
|
|
- Provide alternative endpoints
|
||
|
|
|
||
|
|
### Phase 3: Sunset (Month 7+)
|
||
|
|
- Remove deprecated endpoints
|
||
|
|
- Return 410 Gone status for removed endpoints
|
||
|
|
|
||
|
|
## Migration Guides
|
||
|
|
|
||
|
|
### From v1 to v2
|
||
|
|
- [Migration guide for v1 → v2](./MIGRATION_V1_V2.md)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-15
|
||
|
|
|