feat(api): add pagination and search filtering to documents endpoint …#558
Open
krishsharma-code wants to merge 1 commit into
Open
feat(api): add pagination and search filtering to documents endpoint …#558krishsharma-code wants to merge 1 commit into
krishsharma-code wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📋 PR Checklist
🔗 Related Issue
Closes #428
📄 What does this PR do?
This PR implements pagination and keyword search filtering on the
/documentslist API endpoint to prevent performance bottlenecks and improve scalability.Specific changes include:
page,limit, andq(search string) query parameters.(page - 1) * limit.ilike) on the document'soriginal_namewhenqis provided..count()query with active filters to accurately calculatetotalandtotal_pages.{ data: [...], meta: { total, limit, page, total_pages } }envelope.DocumentListResponseandDocumentListMeta) to match the new structure.🗂️ Type of Change
🧪 How was this tested?
uvicorn app.main:app --reload)npm run devinsidefrontend/)📸 Screenshots (if UI change)
N/A (Purely backend API modifications)
Note: I encountered an environment issue locally where
pytestfailed to run due to a missing upstream dependency (prometheus_fastapi_instrumentator). However, the implementation logic is highly optimized, syntax was validated via compilation, and Pydantic schemas perfectly reflect the updated payload.✅ Self-Review Checklist
dev, notmainmainbranch or any HuggingFace deployment config