Skip to content

docs(store): document GET and distinguish from readiness checks - #555

Merged
imbajin merged 3 commits into
apache:masterfrom
hugegraph:codex/document-store-process-lifecycle
Nov 1, 2026
Merged

imbajin merged 3 commits into
apache:masterfrom
hugegraph:codex/document-store-process-lifecycle

Conversation

@imbajin

@imbajin imbajin commented Oct 31, 2026 •

Copy link
Copy Markdown
Member

Summary

Document Store process lifecycle observation endpoint GET /-/lifecycle introduced in HugeGraph 1.8.0 (apache/hugegraph#3441):

  • Added GET /-/lifecycle to the Store read-only endpoint table in both Chinese and English documentation.
  • Documented the 4 lifecycle states: STARTING, STARTED, STOPPING, and UNAVAILABLE.
  • Added an OINK warning callout emphasizing that STARTED is only local JVM/gRPC process readiness and NOT storage/cluster readiness; rolling updates and node replacements must verify PD GET /v1/stores for Up state and per-partition Raft group health via GET /v1/partitions.
  • Clarified that pre-1.8.0 versions return HTTP 404, which must not be treated as STARTED.
  • Removed tentative/proposed wording and removed AI-generated screenshots and disclaimers.

Related PRs

@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: yes. Summary: The /-/lifecycle states, JSON shape and 404 behaviour match StoreProcessLifecycle in apache/hugegraph#3441, but that PR is unmerged, so both pages would document an endpoint no build serves, in wording that never names the build that does.

@imbajin imbajin changed the title docs: distinguish Store process lifecycle from readiness docs(store): document GET /-/lifecycle and distinguish from readiness checks Nov 1, 2026
@imbajin

imbajin commented Nov 1, 2026

Copy link
Copy Markdown
Member Author

Thanks for the review @bitflicker64! Upstream Store implementation apache/hugegraph#3441 has now been merged into master for HugeGraph 1.8.0.
Updated both pages to:

  1. Explicitly designate the endpoint availability as HugeGraph 1.8.0+ and remove tentative/unmerged wording.
  2. Polish the warning callout and wrap prose at 160 characters in line with project guidelines.

@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 /-/lifecycle path, {"status":0,"text":...} shape, four states, precedence and pre-1.8.0 404 match HgStoreStatusController and StoreProcessLifecycle on master after apache/hugegraph#3441, and the EN and CN pages agree.

@imbajin imbajin changed the title docs(store): document GET /-/lifecycle and distinguish from readiness checks docs(store): document GET and distinguish from readiness checks Nov 1, 2026
@imbajin
imbajin merged commit cd19641 into apache:master Nov 1, 2026
5 checks passed
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.

3 participants