docs(FI-02): add GET list documents API with filters#14
Open
hoanninh123 wants to merge 1 commit intodevfrom
Open
docs(FI-02): add GET list documents API with filters#14hoanninh123 wants to merge 1 commit intodevfrom
hoanninh123 wants to merge 1 commit intodevfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds OpenAPI documentation for a new authenticated GET /api/v1/documents endpoint so document lists can be retrieved with filtering and pagination. This fits the existing API spec by extending the document section with a list operation alongside the existing create/get/update document endpoints.
Changes:
- Added
GET /api/v1/documentswith query filters for keyword, active status, issued-date range, and pagination. - Documented the 200 response payload with document fields and paging metadata.
- Added 400/401/403/500 response definitions and examples for the new endpoint.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+2771
to
+2775
| pagination: | ||
| total: 42 | ||
| page: 1 | ||
| limit: 20 | ||
| totalPages: 3 |
Comment on lines
+2706
to
+2739
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| documentID: | ||
| type: string | ||
| example: "12345" | ||
| title: | ||
| type: string | ||
| example: "Luật Đất đai 2024" | ||
| documentCode: | ||
| type: string | ||
| example: "31/2024/QH15" | ||
| isActive: | ||
| type: boolean | ||
| example: true | ||
| issuedDate: | ||
| type: string | ||
| format: date | ||
| example: "2024-01-18" | ||
| effectiveDate: | ||
| type: string | ||
| format: date | ||
| example: "2024-07-01" | ||
| sourceUrl: | ||
| type: string | ||
| format: uri | ||
| example: "https://thuvienphapluat.vn/van-ban/..." | ||
| version: | ||
| type: string | ||
| example: "v1" | ||
| meta: | ||
| type: object | ||
| properties: |
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.
No description provided.