Skip to content

docs: explain configuration and schema graph cloning - #58

Open
imbajin wants to merge 3 commits into
masterfrom
codex/document-schema-clone
Open

imbajin wants to merge 3 commits into
masterfrom
codex/document-schema-clone

Conversation

@imbajin

@imbajin imbajin commented Oct 30, 2026 •

Copy link
Copy Markdown

Clarify that clone_graph_name copies configuration only and is a query parameter. Document the separate schema-only endpoint proposed in hugegraph/hugegraph#361, including its version prerequisite, same-space scope, no-edge-label restriction, empty data, and partial-target failure handling, in English and Chinese.

Validation:

  • Head 7b15acf: bash dist/validate-links.sh and git diff --check passed after the version and edge-label clarifications. The broader checks below ran on the preceding head d9d3d06.
  • bash dist/validate-links.sh and git diff --check passed.
  • Python source suite: 290 tests run, one skipped, no failures, using Hugo 0.168.0, Go 1.27.3, and WebP tools.
  • scripts/hugo.sh build and latest versioned artifact build/validation passed in both languages.
  • Chromium search-ranking.spec.js: 35 passed against the latest artifact.

Keep this PR paired with the Server API change; sources with any edge labels are rejected before creating the target. Clients require GET /versions API 0.73.0.0 or later. The change has not yet been released.

Summary by CodeRabbit

  • 文档
    • 明确普通克隆仅复制图配置,不复制 Schema 或图数据;clone_graph_name 需作为查询参数传入。
    • 补充 Schema 复制接口的版本要求、请求格式、权限要求及复制范围;操作期间源 Schema 须保持不变,且不复制图数据。
    • 说明复制失败可能留下部分创建的目标图,重试前应检查并显式删除;旧版 Server 不支持该接口,普通克隆的成功响应不代表 Schema 复制成功。

ASF upstream PR: apache#554

@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 49 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 86d53056-dc20-4710-bab2-af65a3b0fd5a
Commits

Reviewing files that changed from the base of the PR and between d52ec0e and 7b15acf.

Files selected for processing: 2
  • content/cn/docs/clients/restful-api/graphs.md
  • content/en/docs/clients/restful-api/graphs.md

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c9a9f2fd-d80c-462f-ab8a-1e60e27d9a88
Commits

Reviewing files that changed from the base of the PR and between d9d3d06 and d52ec0e.

Files selected for processing: 2
  • content/cn/docs/clients/restful-api/graphs.md
  • content/en/docs/clients/restful-api/graphs.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

中英文 REST API 文档明确了图克隆的行为边界,并新增独立的 Schema 复制接口说明,涵盖复制范围、权限、请求与响应要求及失败处理。

Changes

图克隆与 Schema 复制

Layer / File(s) Summary
图克隆行为边界
content/cn/docs/clients/restful-api/graphs.md, content/en/docs/clients/restful-api/graphs.md
中英文文档说明,普通图克隆只复制源图配置,不复制 Schema 或图数据。clone_graph_name 必须作为查询参数传递,不能放入 JSON 请求体。
Schema 复制接口说明
content/cn/docs/clients/restful-api/graphs.md, content/en/docs/clients/restful-api/graphs.md
中英文文档新增独立的 Schema 复制接口说明,涵盖最低 API 版本、复制范围、权限、请求格式和响应字段。文档还说明失败后可能留下部分创建的目标图,重试前需要检查并显式删除。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

  • hugegraph/hugegraph-doc#53:该 PR 在 SeaTunnel 迁移文档中说明 Schema 复制范围和限制,与本次新增的 Schema 复制文档内容相关。
Merge Risk: Minimal · previous review d52ec

No actionable merge-blocking issue is established for these documentation changes. Merge with the normal documentation checks and coordinate publication with the corresponding Server API availability.

Pre-merge checks: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed 标题准确概括了本次变更的主要内容:说明配置克隆和 Schema 图克隆。标题简洁、具体,并与英文和中文文档的修改一致。
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

兔子翻开图谱页,
找到克隆的边界。
Schema 键与标签,
索引也列得清爽。
图数据不随行,
检查失败再启程。

@github-actions

Copy link
Copy Markdown

@codecov-ai-reviewer review

@imbajin
imbajin marked this pull request as ready for review October 30, 2026 21:00
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-31T04:08:29.294456Z 7b15acf New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

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.

1 participant