You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "liuxiaocs7 (via GitHub)" <gi...@apache.org> on 2023/06/02 14:18:44 UTC
[GitHub] [incubator-hugegraph-doc] liuxiaocs7 opened a new issue, #260: [Bug] RESTful API response are outdated
liuxiaocs7 opened a new issue, #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260
### Problem Type (问题类型)
typo (错别字和描述优化)
### Your Question (问题描述)
- RESTful API response is outdated and needs to be updated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3381658918
> [@imbajin](https://github.com/imbajin) Is anyone currently working on improving the PropertyKey API? If not, please assign it to me.
Nope & fine to assign u, could open a sub-issue for it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "Swadeep006 (via GitHub)" <gi...@apache.org>.
Swadeep006 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3638360083
hi @imbajin, Is anyone currently working on improving other APIs? If not, please assign it to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3650453737
> helo [@imbajin](https://github.com/imbajin) , i'm finding difficulty in understanding this vertexlabel api work since 2 days, i did try to solve but couldn't, are there any resources so that i can understand this clearly! sorry if i'm taking lot of time!
@Swadeep006 Could u please point out which section/phrase/words u r not able to understand?
I need more details about it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "rajanarahul93 (via GitHub)" <gi...@apache.org>.
rajanarahul93 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-2614946403
Request to Assign:
Please assign this issue to me, and I will work on improving the documentation to address high-frequency user group questions.
My Approach:
Identify Documentation Gaps: Review each listed issue (e.g., Docker hostname, 404 errors, outdated versions mapping) to understand the context and required fixes.
Docker-Specific Updates: Clarify hostname usage for Hubble in Docker, ensure consistent port configurations, and provide details on how containers can join a bridge network.
Preload and Sample Graphs: Reorganize instructions for preloading sample graphs and include appropriate links for better user navigation.
Swagger-UI and Loader Documentation: Add sections about using Swagger-UI and highlight loader usage over Hubble for data loading.
Fix Errors: Address broken links and translation gaps in the download page.
Submit Pull Request: Update the relevant documentation files and submit a detailed pull request for review.
This effort will enhance usability and resolve common user queries effectively.
@imbajin
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "LYD031106 (via GitHub)" <gi...@apache.org>.
LYD031106 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3377596162
@imbajin Is anyone currently working on improving the PropertyKey API? If not, please assign it to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "Swadeep006 (via GitHub)" <gi...@apache.org>.
Swadeep006 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3661172114
Hi @imbajin ,
I’ve submitted a PR to update the VertexLabel API documentation based on testing with HugeGraph Server v1.5.0.
It aligns the request/response examples with actual server behavior and addresses issue #260.
Could you please take a look when you have time?
Thanks a lot for your guidance earlier!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "liuxiaocs7 (via GitHub)" <gi...@apache.org>.
liuxiaocs7 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-2630322128
Hi, @rajanarahul93, thanks for your interest. ASSIGN to you, you can start with any unfinished task.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "Swadeep006 (via GitHub)" <gi...@apache.org>.
Swadeep006 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3656620448
I’m working on updating the VertexLabel API docs and testing the endpoints locally via Postman.
When I try to create a VertexLabel, the server responds with 401 Unauthorized.
I wanted to check:
whether authentication is required by default for this endpoint in recent versions, and
which auth method should be used (Basic auth / token / something else) when testing this API.
Could you please clarify the expected authentication setup for the Create VertexLabel API?
Thanks in advance for your help!
<img width="1087" height="903" alt="Image" src="https://github.com/user-attachments/assets/3af09345-a66f-48b5-ab29-cfed164a5928" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3639986537
> hi [@imbajin](https://github.com/imbajin), Is anyone currently working on improving other APIs? If not, please assign it to me.
THX~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-doc] imbajin commented on issue #260: [Bug] RESTful API response are outdated
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-1574810379
> 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
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-doc] imbajin commented on issue #260: [Improvement] RESTful API request/response content need update
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-1600092176
Other content also need update, anyone could comment here & take the job (I'll update the status)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-doc] liuxiaocs7 commented on issue #260: [Bug] RESTful API response are outdated
Posted by "liuxiaocs7 (via GitHub)" <gi...@apache.org>.
liuxiaocs7 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-1573830078
Hi, @imbajin, this task seems to be divided into many sub-tasks, which is more friendly to new comers.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "Swadeep006 (via GitHub)" <gi...@apache.org>.
Swadeep006 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3647308316
helo @imbajin , i'm finding difficulty in understanding this since 2 days, i did try to solve but couldn't, are there any resources so that i can understand this clearly! sorry if i'm taking lot of time!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "LYD031106 (via GitHub)" <gi...@apache.org>.
LYD031106 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3345441115
Hi maintainers, I am a new contributor and would like to help with the translation. is this issue still active? If so, could you please let me know which files are still available for translation? Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-doc] VGalaxies commented on issue #260: [Improvement] RESTful API request/response content need update
Posted by "VGalaxies (via GitHub)" <gi...@apache.org>.
VGalaxies commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-1600058683
@imbajin Is anyone currently working on improving the Edge API? If not, please assign it to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "rajanarahul93 (via GitHub)" <gi...@apache.org>.
rajanarahul93 commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-2614950385
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!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3658710648
@Swadeep006
> whether authentication is required by default for this endpoint in recent versions
A: Nope, auth mode is not required in any API.
> which auth method should be used (Basic auth / token)
Both works, prefer basic-auth first
<img width="1099" height="751" alt="Image" src="https://github.com/user-attachments/assets/d7de2bf1-f744-4b05-b424-bc21fc1877fe" />
---
refer https://hugegraph.apache.org/docs/config/config-authentication/#configure-user-authentication (HG doesn't enable the auth by default (in binary/source release)
However, due to some SEC risks, we suggest enabling it in the Docker container (
<img width="757" height="238" alt="Image" src="https://github.com/user-attachments/assets/88686732-7194-4bfc-8c04-2d3a34a58d87" />)
if we run container with the `passwd` param, it will auto enable the auth mode
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [I] [Improvement] RESTful API request/response content need update [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on issue #260:
URL: https://github.com/apache/incubator-hugegraph-doc/issues/260#issuecomment-3350983940
> Hi maintainers, I am a new contributor and would like to help with the translation. is this issue still active? If so, could you please let me know which files are still available for translation? Thanks!
@LYD031106 The current translation work still needs to be continuously promoted. Thanks to the significant improvement in the capabilities of Large Language Models (LLM), we can utilize deepwiki and LLM for source code-level document confirmation and understanding, even directly having the LLM scan the parts with differences in Chinese and English documents. This method is often more reliable than individual recollection.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org