From fce69683a5e767bd28b899297058e7013853c737 Mon Sep 17 00:00:00 2001 From: Aherobo Ovie Victor Date: Tue, 8 Jul 2025 19:11:19 +0100 Subject: [PATCH] docs: Update API endpoints section to include all 13 endpoints MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🔧 FIXED MISSING ENDPOINTS: - Updated 'All 10 API Endpoints' to 'All 13 API Endpoints' - Added missing 3 AI Analysis endpoints: * POST /analyze-article - AI article analysis * POST /generate-insights - AI insights generation * GET /ai-status - AI system status - Organized endpoints by functional categories - Enhanced descriptions with parameters ✅ COMPLETE ENDPOINT DOCUMENTATION: - All 13 endpoints now properly documented - Consistent formatting and categorization - Ready for developer reference and integration --- docs/README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index bdbd26e..0224cc9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -265,17 +265,30 @@ Our implementation includes: ## 🔌 API Endpoints -### All 10 API Endpoints -* `GET /` - API health check -* `GET /health` - Detailed system status +### All 13 API Endpoints + +#### **Core System (3)** +* `GET /` - API health check and version info +* `GET /health` - Detailed system status and vector store metrics +* `GET /stats` - Comprehensive system statistics and performance data + +#### **News Management (2)** * `POST /fetch-news` - Fetch latest news from all RSS sources -* `GET /recommend-news` - Get recommendations by article ID +* `GET /articles?limit=N&offset=M` - Get articles with pagination and advanced filtering + +#### **Recommendations (4)** +* `GET /recommend-news?article_id=X&top_k=N` - Get recommendations by article ID * `POST /recommend-by-query` - Get recommendations based on text query * `POST /recommend-by-interests` - Get recommendations by user interests -* `GET /trending?top_k=N` - Get N most recent articles -* `GET /articles?limit=N` - Get N articles from database with filtering -* `POST /search` - Advanced search with multiple filters -* `GET /stats` - System statistics and metrics +* `GET /trending?top_k=N` - Get N most trending articles + +#### **Search & Discovery (1)** +* `POST /search` - Advanced semantic search with multiple filters + +#### **AI Analysis (3)** +* `POST /analyze-article` - AI-powered article analysis (summary, sentiment, keywords) +* `POST /generate-insights` - Generate AI insights from multiple articles +* `GET /ai-status` - Check AI system status and capabilities ### Example Responses