[DOCS] Fix API reference documentation vs backend implementation mismatch#45
Conversation
- Removed non-existent `GET /questions/search` endpoint documentation. - Updated `GET /questions` with supported query parameters: `type`, `difficulty`, `isVerified`, `page`, and `limit`. - Updated `Papers API` documentation with correct query parameters (`examYear`, `examType`) and added `PATCH /papers/:id/status`. - Removed unsupported `type` parameter from `Search API`. - Updated `Syllabus API` with correct hierarchical routes and question mapping endpoints. - Updated `Users API` and `Subjects API` to reflect slug-based lookups and current route definitions. This alignment ensures that developers and AI agents have an accurate reference for the platform's REST API. Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
1 participant
This PR fixes the discrepancy between the API documentation and the backend implementation. The primary issue was the documentation of a non-existent
GET /questions/searchendpoint, which has been removed and replaced with appropriate query parameters on the baseGET /questionsendpoint. Additionally, a comprehensive audit of all API reference files was performed, updating parameters, path segments (slug vs ID), and adding missing status update endpoints to ensure full parity with thebackend/src/routesimplementation.Fixes #44
PR created automatically by Jules for task 9817437919961773783 started by @hasanraiyan