Skip to content

Conversation

@Swadeep006
Copy link
Contributor

Purpose of the PR

This PR updates the VertexLabel REST API documentation to align with
the actual HugeGraph Server v1.5.0 behavior.

Changes

  • Updated Create VertexLabel request and response examples
  • Corrected Get VertexLabel and List VertexLabels response formats
  • Unified id_strategy usage to PRIMARY_KEY
  • Updated TTL-related examples
  • Added notes about PropertyKey prerequisites and Docker authentication behavior

All examples were verified using a local HugeGraph 1.5.0 Docker setup.
image
image
image

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Dec 16, 2025
@VGalaxies
Copy link
Contributor

VGalaxies commented Dec 17, 2025

@imbajin, have the APIs for 1.5.0 and 1.7.0 changed (ignoring graphspace for now)?

@Swadeep006, please update the Chinese documentation as well, could use LLM to assist :)

@Swadeep006
Copy link
Contributor Author

Hi @VGalaxies ,CN documentation has been updated and kept in sync with EN. once check it!

@VGalaxies VGalaxies requested a review from imbajin December 17, 2025 07:16
@imbajin
Copy link
Member

imbajin commented Dec 17, 2025

@Swadeep006 Hi, we should use 1.7.0 as the docker image version (also need update 1.5.0 → 1.7.0 in all docs)

due to graphspace feature will influence almost all APIs → https://hugegraph.apache.org/docs/clients/restful-api/

image

If this hint/note isn't working well, let's consider adding a universal header to all API pages. This way, we can clearly notify users at the top of the page to check the old documentation if their server version is prior to 1.7.

also cc @VGalaxies

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Improvement] RESTful API request/response content need update

3 participants