24 lines
785 B
Markdown
24 lines
785 B
Markdown
|
## Issue #4: API Versioning Policy
|
||
|
|
|
||
|
|
### Description
|
||
|
|
|
||
|
|
Implement a clear API versioning policy for the helpyourneighbour project.
|
||
|
|
|
||
|
|
### Acceptance Criteria
|
||
|
|
|
||
|
|
- [ ] Create a document outlining the API versioning strategy
|
||
|
|
- [ ] Define version format and deprecation policy
|
||
|
|
- [ ] Document version history
|
||
|
|
- [ ] Apply versioning to existing API endpoints
|
||
|
|
|
||
|
|
### Tasks
|
||
|
|
|
||
|
|
- [x] Create `docs/api-versioning.md`
|
||
|
|
- [x] Define version format as `vX.Y.Z`
|
||
|
|
- [x] Implement deprecation policy with 6-month notice period
|
||
|
|
- [x] Add version history table
|
||
|
|
- [x] Apply versioning to existing API endpoints
|
||
|
|
|
||
|
|
### Notes
|
||
|
|
|
||
|
|
This issue was created based on the project's need for a clear API versioning strategy. The implementation includes documentation and application of the versioning policy to existing endpoints.
|