HTTP API documents, part1 #2713
Merged
Conversation
This file contains 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
Signed-off-by: Jin Hai <[email protected]>
yuzhichang
reviewed
Oct 4, 2024
|
|
||
| ```shell | ||
| { | ||
| "code": 0 |
There was a problem hiding this comment.
Need to unify code and error_code.
api/http_api.md
Outdated
|
|
||
| ## List files of a dataset | ||
|
|
||
| **GET** `/api/v1/dataset/{dataset_id}/documents?keywords={keyword}&page={page}&page_size={limit}&orderby={orderby}&desc={desc}` |
There was a problem hiding this comment.
No document for page and page_size
There was a problem hiding this comment.
page and page_size is offset and limit to show in one page.
Signed-off-by: Jin Hai <[email protected]>
Signed-off-by: Jin Hai <[email protected]>
Signed-off-by: Jin Hai <[email protected]>
Halfknow
pushed a commit
to Halfknow/ragflow
that referenced
this pull request
Nov 11, 2024
### What problem does this PR solve? 1. dataset: create/delete/list/get/update 2. files in dataset: upload/download/list/delete/get_info ### Type of change - [x] Documentation Update --------- Signed-off-by: Jin Hai <[email protected]>
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.
What problem does this PR solve?
Type of change