Versioning

Fast-Crawl follows a clear versioning strategy to ensure stability and backward compatibility for API consumers.

API Versioning

• REST API: All endpoints are versioned under /v1/ (e.g., /v1/search).
• tRPC API: The tRPC router is versioned and updated in lockstep with the REST API.
• Breaking changes: Any breaking change will result in a new versioned path (e.g., /v2/).
• Deprecation: Old versions remain available for a reasonable period and are marked as deprecated in the documentation.

Release Policy

• Stable releases: Major and minor releases are tagged in the GitHub repository.
• Changelog: All changes are documented in the release notes and changelog.
• Backward compatibility: Minor and patch releases do not break existing clients.

How to Select API Version

• Use the latest /v1/ endpoints for new integrations.
• Monitor the documentation and changelog for upcoming deprecations or new features.

Questions?

For versioning or migration help, open an issue on GitHub.