Skip to content

docs: clarify Server and Hubble HTTP API contracts - #552

Open
imbajin wants to merge 10 commits into
apache:masterfrom
hugegraph:docs/issue-103-http-contracts
Open

imbajin wants to merge 10 commits into
apache:masterfrom
hugegraph:docs/issue-103-http-contracts

Conversation

@imbajin

@imbajin imbajin commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Before → After

HTTP workflows lack concrete request examples and clear boundaries between Server, Hubble and optional engines. Add bilingual guides for GraphSpace Gremlin aliases, asynchronous jobs, Hubble sessions, schema defaults, counts and element-ID encoding, with Vermeer loading/computation examples and version-aware navigation.

Align optional-engine HTTP access guidance with mode defaults while retaining authentication and internal RPC/Worker boundaries.

Dependencies and validation boundary

Pair the documented behavior with 🔗 Server #3431 and 🔗 Toolchain #859. The author reports source/link tests, a Hugo build and browser search checks; these were not independently rerun here and do not establish large-dataset, runtime or RC acceptance.

The source branch predates the latest Helm documentation changes; overlapping documentation conflicts still need reconciliation before merge.

Source: 🔗 org Doc #56.

Visual overview

Distinct Server Hubble and Vermeer HTTP request and task contracts

Server, Hubble and Vermeer use distinct request and task contracts. Select GraphSpace aliases, retain the session and returned task ID, and distinguish transport from execution timeouts. Documentation illustration only; paired 🔗 Server #3431 and 🔗 Toolchain #859 behavior and runtime/RC acceptance remain separate.

orion added 3 commits October 28, 2026 16:54
Correct optional engine HTTP Service defaults in both languages.
Document graphspace Gremlin aliases and asynchronous count jobs.
Explain Hubble session, schema, statistics and element ID formats.
Comment thread content/en/docs/quickstart/toolchain/http-api.md

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: no. Summary: the Server, Hubble and Vermeer contracts on the new http-api pages match master source; one minor issue remains where the native Vermeer link points at the hugegraph/hugegraph-computer fork instead of the ASF repository.

`GET /api/v1/tasks/value/{id}`. These paths and positive IDs differ from Hubble's wrapper.
`POST /api/v1/tasks` does not submit work: after the task-method fix it returns HTTP 405 and `Allow: GET`;
older builds can return a misleading `{"code":200}` without creating a task.
See the [native API examples](https://github.com/hugegraph/hugegraph-computer/blob/master/vermeer/README.md#api-overview).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: this link, and the same one at content/cn/docs/quickstart/toolchain/http-api.md:229, sends readers to the hugegraph/hugegraph-computer fork, which can drift from the ASF source. Point both at https://github.com/apache/hugegraph-computer/blob/master/vermeer/README.md#api-overview, which has the same API Overview section.

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: no. Score: 9/10. Summary: the Server, Hubble and Vermeer contracts on the new http-api pages match master of apache/hugegraph, apache/hugegraph-toolchain and apache/hugegraph-computer, and both earlier review comments are addressed at this head.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants