Skip to content

docs(api): clarify quotas, loading ownership and deletion - #569

Open
imbajin wants to merge 4 commits into
apache:masterfrom
hugegraph:docs/server-api-semantics-20261115
Open

imbajin wants to merge 4 commits into
apache:masterfrom
hugegraph:docs/server-api-semantics-20261115

Conversation

@imbajin

@imbajin imbajin commented Nov 16, 2026

Copy link
Copy Markdown
Member

Purpose of the PR

Correct the bilingual REST reference where outdated semantics can change how clients limit results, update quotas or delete graph spaces.

  • Explain distinct-crosspoint limits, GraphSpace defaults and omitted-versus-zero compute limits.
  • Describe the PD-first prerequisite and partial-failure behavior of graph-space deletion.
  • Align LOADING ownership with the implemented protocol, restore the FAQ clear-graph link, and make the authorization model easier to read.

Validation: source-contract review, bilingual/anchor checks, strict build and independent artifact validation passed. Desktop/mobile checks covered the reference tables and deletion guidance. Public routes and existing heading links are preserved.

Pending standalone-storage and GraphID changes remain in their existing 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: no. Summary: The crosspoint limit, GraphSpace defaults, compute-limit inheritance, update requirements and PD-first deletion text match GraphSpaceAPI, GraphManager.dropGraphSpace and PD ConfigService on master. One wording issue in the LOADING ownership intro, in both languages.

@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 crosspoint limit, GraphSpace create defaults, compute-limit update semantics, PD-first deletion guidance and LOADING ownership text match GraphSpaceAPI, GraphManager.dropGraphSpace, PD ConfigService and GraphsAPI on master, and the earlier LOADING wording comment is fixed. One time-anchored sentence remains under the create table, in both languages.

@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 crosspoint limit, GraphSpace create defaults, compute-limit update semantics, PD-first deletion guidance and LOADING ownership text match CustomizedCrosspointsTraverser, GraphSpaceAPI, GraphManager.dropGraphSpace, PD ConfigService and GraphsAPI on master, and both earlier wording comments are fixed in both languages.

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Score: 7.0/10 · Confidence: high

Blocking: yes

Summary

The new GraphSpace create and update instructions omit a version boundary: following them against Server 1.7.0 can fail creation or silently retain a compute quota.

Evidence

Server 1.7.0 GraphSpaceAPI initializes the omitted create limits to zero and checks them greater than zero; its update handler ignores zero compute limits. Current master handles these cases differently.

Validation notes

Compared source code and the 1.7.0 tag; did not run a Server/PD deployment. The existing Kubernetes namespace omission is pre-existing and outside the changed lines.

| storage_limit | Yes | Int | | > 0 | Maximum disk usage, in GB |
| compute_cpu_limit | No | Int | 0 | >= 0 | Extra HugeGraph-Computer CPU cores; falls back to `cpu_limit` if unset or 0 |
| compute_memory_limit | No | Int | 0 | >= 0 | Extra HugeGraph-Computer memory in GB; falls back to `memory_limit` if unset or 0 |
| cpu_limit | No | Int | 128 | > 0 | CPU cores for the graphspace |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Specify the Server version for create defaults

On Server 1.7.0, omitting cpu_limit, memory_limit, storage_limit or max_graph_number leaves it at zero, and JsonGraphSpace.checkCreate() rejects the request. These defaults apply to the newer implementation, so the table can lead 1.7.0 users to submit a request that fails. Please state the applicable version or build and retain the older requirements in both languages.

> graphspace settings with `GET /graphspaces/{name}` first and preserve fields that are not being changed.
> - **Compute Limit Inheritance**: Setting `compute_cpu_limit: 0` or `compute_memory_limit: 0` (or omitting them on creation) means continuously
> inheriting `cpu_limit` and `memory_limit`. Zero represents inheritance, not unlimited or zero allocation.
> On update, omitting a compute field preserves its current setting; explicit zero restores inheritance. Responses retain that zero marker.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Qualify the zero-reset behavior by version

Server 1.7.0's update handler only applies a compute limit when it is nonzero, so sending 0 leaves an existing independent limit unchanged rather than restoring inheritance. Please identify the versions or builds supporting this reset and describe the older behavior in both languages.

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