[Improvement] RESTful API request/response content need update

[liuxiaocs7]

Problem Type (问题类型)

outdated info & typo (错别字和描述优化)

Your Question (问题描述)

• RESTful API response is outdated and needs to be updated (use newest server 1.0)
• Provide a minimum flow of test cases that can be run whenever possible
• Some translation could be improved by GPT/New Bing, try to paste the phrase and ask it for the improvement (refer: docs: add email list subscribe guide #258 (comment))

RESTful API check Subtasks:

• Vertex API docs: update outdated response in vertex api #259
• Edge API (doc: update outdated doc for edge api #276 @VGalaxies)
• VertexLabel API (docs: update VertexLabel API examples to match HugeGraph Server v1.5.0 #442 @Swadeep006)
• EdgeLabel API
• IndexLabel API
• Graphs API
• Gremlin API
• Auth API
• Traverser API
• Schema API
• Rank API
• Rask API
• Rebuild API

---

Anyone interested in this task please leave a comment below, as far as possible each PR corresponds to a task so that the maintainer can better review the code.

Note: Refer the instruction to setup the IDEA code/doc style settings first (if u use it)

[liuxiaocs7]

Hi, @imbajin, this task seems to be divided into many sub-tasks, more friendly to newcomers.

Others could refer #259 to enhance the doc & submit PR

[imbajin]

Hi, @imbajin, this task seems to be divided into many sub-tasks, more friendly to newcomers.

yep, refer #109 we could add a TODO list for it

[VGalaxies]

@imbajin Is anyone currently working on improving the Edge API? If not, please assign it to me.

[imbajin]

Other content also need update, anyone could comment here & take the job (I'll update the status)

[rajanarahul93]

Request to Contribute @imbajin :
Please assign specific subtasks for the RESTful API documentation updates to me, as I would like to contribute to resolving the outdated response and improving translations.

Planned Steps:

Review Outdated Responses:

Cross-check the current RESTful API documentation against the latest server version (1.0) for discrepancies.
Focus on identified APIs (Vertex, Edge, VertexLabel, EdgeLabel, etc.) to ensure responses are accurate.
Improve Translations:

Use tools like GPT or Bing to refine translation phrases where necessary.
Test Cases:

Add minimum flow test cases where applicable to validate the accuracy of API request/response content.
Documentation Structure:

Update documentation formatting and highlight key changes for better readability.
Submit Subtask-Specific PRs:

Work on subtasks individually (e.g., Edge API, VertexLabel API) to make review easier for maintainers.
Expected Outcome:

Accurate and up-to-date RESTful API documentation with enhanced translations and better clarity.
Structured PR submissions for efficient review and integration.
Please let me know which subtask I can begin with!

[liuxiaocs7]

Hi, @rajanarahul93, thanks for your interest. ASSIGN to you, you can start with any unfinished task.