Versioning¶
How the Tajiri Vision API is versioned and how changes are communicated.
Current Version¶
| API Version | 1.0.0 (Beta) |
| Base URL | https://api.tajirifarm.com |
| Status | Public Beta |
Versioning Policy¶
The API follows Semantic Versioning:
| Type | When | Example | Breaking? |
|---|---|---|---|
| MAJOR | Incompatible API changes | New response structure | Yes |
| MINOR | New features, backwards-compatible | New parameter added | No |
| PATCH | Bug fixes, improvements | Better accuracy | No |
Breaking vs Non-Breaking Changes¶
Non-Breaking Changes (no action required)¶
These changes are deployed without version bump:
- Adding new optional request parameters
- Adding new fields to the response
- Adding new enum values
- Improving diagnosis accuracy
- Adding new languages
- Adding new supported crops
- Performance improvements
Breaking Changes (major version bump)¶
These changes require a major version update:
- Removing or renaming existing fields
- Changing field types
- Changing default values
- Removing enum values
- Changing the response structure
- Changing the endpoint URL
How Changes Are Communicated¶
| Channel | What |
|---|---|
| Changelog | All changes documented |
| Response headers | X-API-Version header |
| Breaking changes announced to partners | |
| Documentation | Updated before or at deployment |
Deprecation Policy¶
When a breaking change is planned:
- Announcement — At least 3 months before removal
- Deprecation header —
Deprecation: truein response headers - Migration guide — Published in documentation
- Dual support — Old and new versions run in parallel during transition
- Removal — After transition period
Beta Disclaimer¶
Beta API
Tajiri Vision API is currently in public beta. During beta:
- The API is stable and production-ready
- Minor breaking changes may occur with shorter notice
- We will always communicate changes before they happen
- Feedback is welcome at contact@tajiri.farm