Updated RESTful API Reference #908
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
|
Validated and improved clarity of the API reference. I may have tempered with the intended meaning, please double check. |
|
There is still room for improvement, for example, descriptions of the API behavior are still on the thin side. But I feel the current version is ready for initial publication. |
KevinHuSh
approved these changes
May 27, 2024
writinwaters
commented
May 27, 2024
|
Add DEMO link at the first paragraph of README |
JinHai-CN
reviewed
May 27, 2024
JinHai-CN
reviewed
May 27, 2024
JinHai-CN
reviewed
May 27, 2024
JinHai-CN
reviewed
May 27, 2024
JinHai-CN
reviewed
May 27, 2024
docs/references/api.md
Outdated
|
|
||
| ## Delete document | ||
| - Path: `/api/document` |
There was a problem hiding this comment.
Path is also not a very proper word. Change it to: Request URI
KevinHuSh
reviewed
May 27, 2024
JinHai-CN
approved these changes
May 27, 2024
1 task
KevinHuSh
pushed a commit
that referenced
this pull request
May 27, 2024
### What problem does this PR solve? Update docnm_kwd to doc_name #908 ### Type of change - [x] Refactoring
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?
Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR.
Type of change