Reference

The Corgi Recommender Service reference documentation provides comprehensive technical details about the system's APIs, database schema, and implementation specifics. These resources are designed for developers who need detailed information for integration, debugging, or extending the platform.

Technical Resources

- **API Reference** --- Complete REST API documentation including authentication, endpoints, request/response formats, and error handling. [:octicons-arrow-right-24: Explore API Documentation](api/index.md) - **Database Schema** --- Detailed PostgreSQL database structure with table definitions, relationships, indexes, and design decisions. [:octicons-arrow-right-24: View Database Schema](database-schema.md)

Quick Links

API Essentials

• Authentication Methods - OAuth 2.0 Bearer token implementation
• Rate Limiting - Request limits and quotas
• Error Handling - Standard error responses and status codes

Database Highlights

• Core Tables - Users, posts, interactions, and recommendations
• Vector Search - pgvector implementation for semantic similarity
• Migration Guide - Database versioning and updates

Additional Resources

Looking for architectural overview?

For a high-level understanding of how these components fit together, see the Architecture Deep Dive in the Concepts section.

Need implementation examples?

The Guides section contains practical tutorials showing how to use these APIs and work with the database in real-world scenarios.

Reference Documentation Standards

All reference documentation follows these principles:

1. Accuracy: Every detail is verified against the actual implementation
2. Completeness: All parameters, fields, and options are documented
3. Examples: Real-world usage examples accompany technical specifications
4. Versioning: Changes are tracked and version-specific information is noted

Contributing to Reference Docs

If you find inaccuracies or missing information in the reference documentation:

1. Check the Contributing Guide
2. Submit corrections via pull request
3. Include code references to support documentation updates
4. Follow the documentation style guide

---

Reference documentation is automatically validated against the codebase during the build process to ensure accuracy.