mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-19 04:40:32 -05:00
Dries Peeters
7534e8abe7
Describe how GET /api/openapi.json sets info.version via get_version_from_setup() (setup.py at runtime, with TIMETRACKER_VERSION or APP_VERSION overrides and Flask APP_VERSION fallback), and point contributors to the same rules in version management and project structure docs. Update the documentation audit entry for the former hardcoded OpenAPI version gap, document tests/test_api_route_contract.py and the refined test_api_v1 isolation guidance in the testing strategy, add a quick-reference pytest invocation for the contract suite, and note info.version in the API consistency audit next to the OpenAPI references.
API Documentation
Complete API reference for TimeTracker REST API.
📖 Overview
TimeTracker provides a comprehensive REST API for programmatic access to all features. The API supports token-based authentication and follows RESTful principles.
📚 Documentation
- REST API - Complete API reference with all endpoints
- Response Format - Standard error envelope and success/legacy response shapes
- API Token Scopes - Understanding token permissions and scopes
- API Versioning - API versioning strategy and best practices
- API Enhancements - Recent API improvements and additions
🔑 Quick Start
- Create an API token in Admin → Security & Access → Api-tokens (or
/admin/api-tokens) - Include the token in the
Authorizationheader:Bearer YOUR_TOKEN - Make requests to the API endpoints
- Review the API Token Scopes to ensure your token has the required permissions
📋 API Endpoints
See the REST API documentation for a complete list of available endpoints organized by resource type.