API doc: Correct Base URL and Dataset URL. #1444
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
The correct URL is http://<host_address>/v1/api , not http://<host_address>/api/v1 .
KevinHuSh
reviewed
Jul 9, 2024
KevinHuSh
reviewed
Jul 9, 2024
| @@ -8,12 +8,12 @@ RAGFlow offers RESTful APIs for you to integrate its capabilities into third-par | |||
|
|
|||
| ## Base URL | |||
| ``` | |||
| http://<host_address>/api/v1/ | |||
| http://<host_address>/v1/api/ | |||
There was a problem hiding this comment.
Your correction is right.
There was a problem hiding this comment.
Can I understand that in future releases the dataset URL will change to http://<host_address>/api/v1/dataset? Why doesn't it stay synchronized with the base URL?
There was a problem hiding this comment.
Yes. Because we want to be consistent with others.
Co-authored-by: Kevin Hu <[email protected]>
paresh2806
pushed a commit
to paresh2806/ragflow
that referenced
this pull request
Jul 11, 2024
The correct URL is http://<host_address>/v1/api , not http://<host_address>/api/v1 . ### What problem does this PR solve? ### Type of change - [x] Documentation Update --------- Co-authored-by: Kevin Hu <[email protected]>
Halfknow
pushed a commit
to Halfknow/ragflow
that referenced
this pull request
Nov 11, 2024
The correct URL is http://<host_address>/v1/api , not http://<host_address>/api/v1 . ### What problem does this PR solve? ### Type of change - [x] Documentation Update --------- Co-authored-by: Kevin Hu <[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.
The correct URL is http://<host_address>/v1/api , not http://<host_address>/api/v1 .
What problem does this PR solve?
Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR.
Type of change